Merge pull request yt-project#3405 from neutrinoceros/check-manifest-…

…gh-workflow

MNT: add a github workflow to run check-manifest

.github/workflows/check-manifest.yaml

@@ -0,0 +1,26 @@
+name: check MANIFEST.in
+on: [pull_request]
+
+jobs:
+  check-manifest:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Source
+      uses: actions/checkout@v2
+    - name: Setup Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+    - name: install check-manifest
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install check-manifest
+    - name: Install yt
+      shell: bash
+      run: |
+        python -m pip install Cython numpy wheel
+        python -m pip install --no-build-isolation .
+    - name: Init submodules
+      uses: snickerbockers/submodules-init@v4
+    - name: run check-manifest
+      run: check-manifest -vvv

MANIFEST.in

@@ -14,6 +14,7 @@ recursive-include yt *.py *.pyx *.pxi *.pxd *.h *.hpp README* *.txt LICENSE* *.c
 recursive-include doc *.rst *.txt *.py *.ipynb *.png *.jpg *.css *.html
 recursive-include doc *.h *.c *.sh *.svgz *.pdf *.svg *.pyx
 include doc/README doc/activate doc/activate.csh doc/cheatsheet.tex
+exclude doc/cheatsheet.pdf
 include doc/extensions/README doc/Makefile
 prune doc/source/reference/api/generated
 prune doc/build

pyproject.toml

@@ -76,3 +76,64 @@ addopts = '''
     --ignore='yt/frontends/owls_subfind/tests/test_outputs.py'
     --ignore='yt/frontends/ramses/tests/test_outputs.py'
 '''
+
+
+[tool.check-manifest]
+# ignore generated C/C++ files, otherwise reported as "missing from VCS" (Version Control System)
+# Please resist the temptation to use patterns instead of exact file names here.
+ignore = [
+  "yt/frontends/artio/_artio_caller.c",
+  "yt/frontends/ramses/io_utils.c",
+  "yt/geometry/fake_octree.c",
+  "yt/geometry/grid_container.c",
+  "yt/geometry/grid_visitors.c",
+  "yt/geometry/oct_container.c",
+  "yt/geometry/oct_visitors.c",
+  "yt/geometry/particle_deposit.c",
+  "yt/geometry/particle_oct_container.cpp",
+  "yt/geometry/particle_smooth.c",
+  "yt/geometry/selection_routines.c",
+  "yt/utilities/cython_fortran_utils.c",
+  "yt/utilities/lib/_octree_raytracing.cpp",
+  "yt/utilities/lib/allocation_container.c",
+  "yt/utilities/lib/alt_ray_tracers.c",
+  "yt/utilities/lib/amr_kdtools.c",
+  "yt/utilities/lib/autogenerated_element_samplers.c",
+  "yt/utilities/lib/basic_octree.c",
+  "yt/utilities/lib/bitarray.c",
+  "yt/utilities/lib/bounded_priority_queue.c",
+  "yt/utilities/lib/bounding_volume_hierarchy.cpp",
+  "yt/utilities/lib/contour_finding.c",
+  "yt/utilities/lib/cosmology_time.c",
+  "yt/utilities/lib/cykdtree/kdtree.cpp",
+  "yt/utilities/lib/cykdtree/utils.cpp",
+  "yt/utilities/lib/cyoctree.c",
+  "yt/utilities/lib/cyoctree.cpp",
+  "yt/utilities/lib/depth_first_octree.c",
+  "yt/utilities/lib/distance_queue.c",
+  "yt/utilities/lib/element_mappings.c",
+  "yt/utilities/lib/ewah_bool_wrap.cpp",
+  "yt/utilities/lib/fnv_hash.c",
+  "yt/utilities/lib/fortran_reader.c",
+  "yt/utilities/lib/geometry_utils.cpp",
+  "yt/utilities/lib/grid_traversal.cpp",
+  "yt/utilities/lib/image_samplers.cpp",
+  "yt/utilities/lib/image_utilities.c",
+  "yt/utilities/lib/interpolators.c",
+  "yt/utilities/lib/lenses.c",
+  "yt/utilities/lib/line_integral_convolution.c",
+  "yt/utilities/lib/marching_cubes.cpp",
+  "yt/utilities/lib/mesh_triangulation.c",
+  "yt/utilities/lib/mesh_utilities.c",
+  "yt/utilities/lib/misc_utilities.cpp",
+  "yt/utilities/lib/origami.c",
+  "yt/utilities/lib/particle_kdtree_tools.cpp",
+  "yt/utilities/lib/particle_mesh_operations.c",
+  "yt/utilities/lib/partitioned_grid.cpp",
+  "yt/utilities/lib/pixelization_routines.cpp",
+  "yt/utilities/lib/points_in_volume.c",
+  "yt/utilities/lib/primitives.c",
+  "yt/utilities/lib/quad_tree.c",
+  "yt/utilities/lib/ragged_arrays.c",
+  "yt/utilities/lib/write_array.c",
+]