compile,readme,stats,test: Rearrange and rename steps

Group "install" and "checkout" steps separately. Treat the step that makes the workflow scripts available as an "install" step, consistently naming it "Install scripts". Treat the step that makes the dependencies available as a "checkout" step.
emacscollective · Oct 17, 2024 · a9aee3a · a9aee3a
1 parent 376e95b
commit a9aee3a
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 17 deletions.
diff --git a/.github/workflows/compile.yml b/.github/workflows/compile.yml
@@ -24,7 +24,7 @@ jobs:
         uses: purcell/setup-emacs@master
         with:
           version: 29.3
-      - name: 'Install workflow scripts'
+      - name: 'Install scripts'
         uses: actions/checkout@v4
         with:
           repository: emacscollective/workflows
@@ -55,7 +55,7 @@ jobs:
         uses: purcell/setup-emacs@master
         with:
           version: ${{ matrix.emacs }}
-      - name: 'Checkout scripts'
+      - name: 'Install scripts'
         uses: actions/checkout@v4
         with:
           repository: emacscollective/workflows

diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml
@@ -12,14 +12,14 @@ jobs:
     name: "Export readme"
     runs-on: ubuntu-latest
     steps:
-      - name: 'Checkout ${{ github.repository }}'
-        uses: actions/checkout@v4
-        with:
-          persist-credentials: false
       - name: 'Install Emacs'
         uses: purcell/setup-emacs@master
         with:
           version: 29.3
+      - name: 'Checkout ${{ github.repository }}'
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - name: 'Export readme'
         run: make html
       - name: 'Configure credentials'

diff --git a/.github/workflows/stats.yml b/.github/workflows/stats.yml
@@ -7,34 +7,40 @@ on:
         required: true
       aws-secret-access-key:
         required: true
+env:
+  pwd: ${{ github.event.repository.name }}
 jobs:
   statistics:
     name: 'Generate statistics'
     # ubuntu-24.04 removed python2
     runs-on: ubuntu-22.04
     steps:
-      - name: 'Checkout ${{ github.repository }}'
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          persist-credentials: false
-      - name: 'Set timezone'
-        run: sudo timedatectl set-timezone Europe/Zurich
       - name: 'Install gitstats dependencies'
         run: sudo apt update && sudo apt install -y gnuplot python2
       - name: 'Install gitstats'
         uses: actions/checkout@v4
         with:
           repository: tarsius/gitstats
-          path: gitstats
+          path: _gitstats
           persist-credentials: false
+      - name: 'Checkout ${{ github.repository }}'
+        uses: actions/checkout@v4
+        with:
+          path: ${{ env.pwd }}
+          fetch-depth: 0
+          persist-credentials: false
+      - name: 'Configure timezone'
+        run: sudo timedatectl set-timezone Europe/Zurich
       - name: 'Generate statistics'
-        run: GITSTATS=../gitstats/gitstats make stats
+        working-directory: ${{ env.pwd }}
+        # GITSTATS must be relative to our docs/ directory.
+        run: GITSTATS=../../_gitstats/gitstats make stats
       - name: 'Configure credentials'
         uses: aws-actions/configure-aws-credentials@v4
         with:
           aws-region: eu-central-1
           aws-access-key-id: ${{ secrets.aws-access-key-id }}
           aws-secret-access-key: ${{ secrets.aws-secret-access-key }}
       - name: 'Publish statistics'
+        working-directory: ${{ env.pwd }}
         run: make stats-upload
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -21,7 +21,7 @@ jobs:
         uses: purcell/setup-emacs@master
         with:
           version: 29.3
-      - name: 'Install workflow scripts'
+      - name: 'Install scripts'
         uses: actions/checkout@v4
         with:
           repository: emacscollective/workflows
@@ -56,7 +56,7 @@ jobs:
         uses: purcell/setup-emacs@master
         with:
           version: ${{ matrix.emacs }}
-      - name: 'Checkout scripts'
+      - name: 'Install scripts'
         uses: actions/checkout@v4
         with:
           repository: emacscollective/workflows
@@ -67,6 +67,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           path: ${{ env.pwd }}
+          fetch-depth: 0
           persist-credentials: false
       - name: 'Install dependencies'
         working-directory: ${{ env.pwd }}