ci: cosmetically improve, update and set permissions of/for workflows, (

#1920)
probot · Nov 16, 2023 · b0f11ff · b0f11ff
1 parent eaf269a
commit b0f11ff
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 42 deletions.
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -26,7 +26,9 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
+      with:
+        persist-credentials: false
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v2

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,5 +1,5 @@
 name: Docs
-"on":
+on:
   push:
     branches:
       - master
@@ -8,14 +8,18 @@ jobs:
     name: docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Check out repository
+        uses: actions/checkout@v4
       - run: git fetch --depth=20 origin +refs/tags/*:refs/tags/*
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: lts/*
           cache: npm
-      - run: npm ci
-      - run: npm run build
-      - run: ./script/publish-docs
+      - name: Install dependencies
+        run: npm ci
+      - name: Build probot
+        run: npm run build
+      - name: Publish documentation
+        run: ./script/publish-docs
         env:
           OCTOKITBOT_PAT: ${{ secrets.OCTOKITBOT_PAT }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,5 +1,5 @@
 name: Release
-"on":
+on:
   push:
     branches:
       - master
@@ -11,14 +11,19 @@ jobs:
     name: release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: lts/*
           cache: npm
-      - run: npm ci
-      - run: npm run build
-      - run: npx semantic-release
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Release
+        run: npx semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -8,15 +8,16 @@ on:
       - opened
       - synchronize
 
+permissions:
+  contents: read
+
 jobs:
   dependency-review:
     name: Dependency Review
     if: github.event_name == 'pull_request'
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
     steps:
-      - name: Check out repo
+      - name: Check out repository
         uses: actions/checkout@v4
         with:
           persist-credentials: false
@@ -27,36 +28,37 @@ jobs:
   license-check:
     name: Check Licenses
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
     steps:
-      - uses: actions/checkout@v4
+      - name: Check out repository
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
-
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
           node-version: lts/*
-
       - name: Install dependencies
         run: npm ci
-
       - name: Check Licenses
         run: npx license-checker --production --summary --onlyAllow="0BSD;Apache-2.0;Apache 2.0;Python-2.0;BSD-2-Clause;BSD-3-Clause;ISC;MIT"
 
   lint:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js lts
-        uses: actions/setup-node@v3
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Use Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: lts/*
           cache: npm
-      - run: npm ci
-      - run: npm run lint
+      - name: Install dependencies
+        run: npm ci
+      - name: Lint
+        run: npm run lint
 
   test-unit:
     name: Test on Node ${{ matrix.node-version }} and ${{ matrix.os }}
@@ -73,14 +75,19 @@ jobs:
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: npm
-      - run: npm ci
-      - run: npm run test
+      - name: Install dependencies
+        run: npm ci
+      - name: Test
+        run: npm run test
 
   test-redis:
     name: Test on Node LTS and Redis 7
@@ -92,16 +99,19 @@ jobs:
           - '6379:6379'
         options: '--entrypoint redis-server'
     steps:
-      - uses: actions/checkout@v4
+      - name: Check out repository
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
       - name: Use Node.js LTS
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: lts/*
           cache: npm
-      - run: npm ci
-      - run: npm run test
+      - name: Install Dependencies
+        run: npm ci
+      - name: Test
+        run: npm run test
         env:
           REDIS_HOST: 127.0.0.1
 
@@ -112,15 +122,22 @@ jobs:
       - test-redis
 
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Use Node.js LTS
+        uses: actions/setup-node@v4
         with:
-          cache: npm
           node-version: lts/*
-      - run: npm ci
-      - run: npm run build
-      - run: npm run test:coverage
-      - name: codecov
+          cache: npm
+      - name: Install Dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Test
+        run: npm run test:coverage
+      - name: Update Codecov
         run: npx codecov
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}