Merge pull request #28 from jeromekelleher/jeromekelleher-patch-1

Fix git metadata for setuptools_scm
tskit-dev · Jan 29, 2021 · ce766cf · ce766cf
2 parents c4e0650 + 67992c3
commit ce766cf
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/.github/workflows/build-deploy.yml b/.github/workflows/build-deploy.yml
@@ -76,6 +76,7 @@ jobs:
           ref: main
           repository: tskit-dev/msprime
           submodules: true
+          fetch-depth: 0 # Needed for setuptools_scm to work correctly
 
       - name: Get commit SHA1 for cache
         run: git rev-parse HEAD > SHA1
@@ -85,15 +86,15 @@ jobs:
         name: Docs cache
         with:
           path: dist
-          key: msprime-docs-v5-${{ hashFiles('SHA1') }}
+          key: msprime-docs-v6-${{ hashFiles('SHA1') }}
 
       - name: Install GSL
         if: steps.docs-cache.outputs.cache-hit != 'true'
         run: sudo apt-get install -y libgsl0-dev
 
       - uses: actions/setup-python@v2
         if: steps.docs-cache.outputs.cache-hit != 'true'
-        name: Setup Pyton
+        name: Setup Python
         with:
           python-version: 3.8
 
@@ -123,7 +124,9 @@ jobs:
         run: |
           venv-latest/bin/activate
           cd docs
-          make
+          make dist
+          # make dist changes the _conf.yml file to write the version number, so drop the change
+          git checkout .
 
       - name: Copy docs
         if: steps.docs-cache.outputs.cache-hit != 'true'
@@ -192,6 +195,7 @@ jobs:
           ref: main
           repository: tskit-dev/tskit
           submodules: true
+          fetch-depth: 0 # Needed for setuptools_scm to work correctly
 
       - name: Get commit SHA1 for cache
         run: git rev-parse HEAD > SHA1
@@ -366,4 +370,4 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.ADMINBOT_TOKEN }}
           BRANCH: gh-pages
           FOLDER: site
-          SINGLE_COMMIT: true
+          SINGLE_COMMIT: true