Merge pull request #117 from actions/use-node-version-file

Use a centralized `.node-version` file

.github/workflows/check-dist.yml

@@ -34,7 +34,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version-file: '.node-version'
           cache: 'npm'
 
       - name: Install dependencies

.github/workflows/check-formatting.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version-file: '.node-version'
           cache: 'npm'
 
       - name: Install dependencies

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: 'CodeQL'
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: '40 0 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ['javascript']
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/lint.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version-file: '.node-version'
           cache: npm
 
       - name: Install dependencies

.github/workflows/rebuild-dependabot-prs.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Setup Node.JS
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version-file: '.node-version'
           cache: 'npm'
 
       - name: Install dependencies

.github/workflows/test.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup Node.JS
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version-file: '.node-version'
           cache: 'npm'
 
       - name: Install dependencies

.node-version

@@ -0,0 +1 @@
+20.10.0

action.yml

@@ -2,7 +2,7 @@ name: 'Configure GitHub Pages'
 description: 'A GitHub Action to enable Pages, extract various metadata about a site, and configure some supported static site generators.'
 author: 'GitHub'
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'
 inputs:
   static_site_generator:
@@ -16,7 +16,7 @@ inputs:
     default: ${{ github.token }}
     required: true
   enablement:
-    description: 'Should a Pages site be enabled for the repository if not so already? This will only work with user-to-server tokens.'
+    description: 'Try to enable Pages for the repository if it is not already enabled. This option requires a token other than `GITHUB_TOKEN` to be provided. In the context of a Personal Access Token, the `repo` scope or Pages write permission is required. In the context of a GitHub App, the `administration:write` and `pages:write` permissions are required.'
     default: 'false'
     required: false
 outputs:

package.json

@@ -26,14 +26,14 @@
   "dependencies": {
     "@actions/core": "^1.10.0",
     "@actions/github": "^5.1.1",
-    "espree": "^9.4.1"
+    "espree": "^9.6.1"
   },
   "devDependencies": {
     "@vercel/ncc": "^0.36.1",
-    "eslint": "^8.34.0",
+    "eslint": "^8.40.0",
-    "eslint-config-prettier": "^8.6.0",
+    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-github": "^4.6.0",
+    "eslint-plugin-github": "^4.10.1",
-    "jest": "^29.4.1",
+    "jest": "^29.7.0",
-    "prettier": "^2.8.4"
+    "prettier": "^2.8.7"
   }
 }

src/api-client.js

@@ -42,7 +42,10 @@ async function findOrCreatePagesSite({ githubToken, enablement = true }) {
     pageObject = await getPagesSite({ githubToken })
   } catch (error) {
     if (!enablement) {
-      core.error('Get Pages site failed', error)
+      core.error(
+        'Get Pages site failed. Please verify that the repository has Pages enabled and configured to build using GitHub Actions, or consider exploring the `enablement` parameter for this action.',
+        error
+      )
       throw error
     }
     core.warning('Get Pages site failed', error)