Merge pull request #19 from actions/no-trailing-slashes

[BREAKING] Remove the trailing slash from `base_url` and `base_path` outputs

.github/workflows/check-dist.yml

@@ -0,0 +1,52 @@
+# When you reference this Action with `uses:` in a workflow,
+# `dist/index.js` is the code that will run.
+# For our project, we generate this file using `ncc`.
+# We need to make sure the checked-in `dist/index.js` actually matches what we expect it to be.
+name: Check dist/
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  check-dist:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Rebuild the dist/ directory
+        run: npm run prepare
+
+      - name: Compare the expected and actual dist/ directories
+        run: |
+          if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
+            echo "Detected uncommitted changes after build in dist folder. See status below:"
+            git diff
+            exit 1
+          fi

.github/workflows/check-formatting.yml

@@ -0,0 +1,34 @@
+name: Checking formatting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node.JS
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Verify formatting
+        run: npm run format:check

.github/workflows/draft-release.yml

@@ -4,6 +4,9 @@ on:
     branches:
       - main
 
+permissions:
+  contents: write
+
 jobs:
   draft-release:
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -1,7 +1,7 @@
 name: Release
 on:
   release:
-    types: [edited]
+    types: [published]
   workflow_dispatch:
     inputs:
       TAG_NAME:

.github/workflows/test.yml

@@ -6,20 +6,29 @@ on:
       - main
   pull_request:
 
+permissions:
+  contents: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
+      - name: Checkout
-      uses: actions/checkout@v3
+        uses: actions/checkout@v3
 
-    - name: Set Node.JS
+      - name: Setup Node.JS
-      uses: actions/setup-node@v3
+        uses: actions/setup-node@v3
-      with:
+        with:
-        node-version: 16.x
+          node-version: 16.x
+          cache: 'npm'
 
-    - name: Install dependencies
+      - name: Install dependencies
-      run: npm ci
+        run: npm ci
-    
+
-    - name: Run tests
+      - name: Run tests
-      run: npm test
+        run: npm test

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
+/src/fixtures/tmp
 
 # Editors
 .vscode/

.prettierrc.yml

@@ -0,0 +1,10 @@
+# Prettier (formatter) configuration
+---
+printWidth: 120
+tabWidth: 2
+useTabs: false
+semi: false
+singleQuote: true
+trailingComma: none
+bracketSpacing: true
+arrowParens: avoid

README.md

@@ -1,6 +1,8 @@
-# Configure-Pages
+# configure-pages
 
-An action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as [starter workflows][starter-workflows].
+A GitHub Action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as [starter workflows][starter-workflows].
+
+See [`set-pages-path.js`](src/set-pages-path.js) for more details on how we configure static site generators to work "out of the box" with GitHub Pages.
 
 # Usage
 
@@ -10,18 +12,13 @@ See [action.yml](action.yml) and the [Pages starter workflows][starter-workflows
 
 In order to release a new version of this Action:
 
-1. Locate the semantic version of the upcoming release (a draft is maintained by the [`draft-release` workflow][draft-release])
+1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release]).
 
-2. Push a matching tag, for instance for `v0.1.0`:
+2. Publish the draft release from the `main` branch with semantic version as the tag name, _with_ the checkbox to publish to the GitHub Marketplace checked. :ballot_box_with_check:
 
-   ```bash
+3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v0`.
-   git tag v0.1.0
-   git push origin v0.1.0
-   ```
 
-3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow][release])
+   ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].
-
-   ⚠️ Environment approval is required.
 
 # License
 
@@ -29,5 +26,7 @@ The scripts and documentation in this project are released under the [MIT Licens
 
 <!-- references -->
 [starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages
+[release-list]: /releases
 [draft-release]: .github/workflows/draft-release.yml
-[release]: .github/workflows/release.yml
+[release]: .github/workflows/release.yml
+[release-workflow-runs]: /actions/workflows/release.yml

action.yml

@@ -1,22 +1,30 @@
-name: "Configure Pages"
+name: 'Configure GitHub Pages'
-description: "An action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as starter workflows."
+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: 'node16'
-  main: "dist/index.js"
+  main: 'dist/index.js'
 inputs:
   static_site_generator:
-    description: "Optional static site generator to attempt to configure (nuxt, next or gatsby)"
+    description: 'Optional static site generator to attempt to configure: "nuxt", "next", "gatsby", or "sveltekit"'
+    required: false
+  generator_config_file:
+    description: 'Optional file path to static site generator configuration file'
     required: false
   token:
-    description: "GitHub token"
+    description: 'GitHub token'
     default: ${{ github.token }}
     required: true
+  enablement:
+    description: 'Should a Pages site be enabled for the repository if not so already?'
+    default: 'true'
+    required: false
 outputs:
   base_url:
-    description: 'GitHub Pages site full base URL. Examples: "https://octocat.github.io/my-repo/", "https://octocat.github.io/", "https://www.example.com/"'
+    description: 'GitHub Pages site full base URL. Examples: "https://octocat.github.io/my-repo", "https://octocat.github.io", "https://www.example.com"'
   origin:
     description: 'GitHub Pages site origin. Examples: "https://octocat.github.io", "https://www.example.com"'
   host:
     description: 'GitHub Pages site host. Examples: "octocat.github.io", "www.example.com"'
   base_path:
-    description: 'GitHub Pages site full base path. Examples: "/my-repo/" or "/"'
+    description: 'GitHub Pages site full base path. Examples: "/my-repo" or ""'

dist/gatsby.js

@@ -0,0 +1,2 @@
+// Default Pages configuration for Gatsby
+module.exports = {}

dist/licenses.txt

@@ -572,24 +572,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
-string-format
-(WTFPL OR MIT)
-
-            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-                    Version 2, December 2004
-
- Copyright (c) 2018 David Chambers <dc@davidchambers.me>
-
- Everyone is permitted to copy and distribute verbatim or modified
- copies of this license document, and changing it is allowed as long
- as the name is changed.
-
-            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-  0. You just DO WHAT THE FUCK YOU WANT TO.
-
-
 supports-color
 MIT
 MIT License
@@ -626,3 +608,16 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+
+
+uuid
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2010-2020 Robert Kieffer and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

dist/next.js

@@ -0,0 +1,3 @@
+// Default Pages configuration for Next
+const nextConfig = {}
+module.exports = nextConfig

dist/nuxt.js

@@ -0,0 +1,2 @@
+// Default Pages configuration for Nuxt
+export default {}

dist/sveltekit.js

@@ -0,0 +1,8 @@
+// Default Pages configuration for SvelteKit
+import adapter from '@sveltejs/adapter-auto'
+
+export default {
+  kit: {
+    adapter: adapter()
+  }
+}

package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "MIT",
       "dependencies": {
-        "@actions/core": "^1.8.2",
+        "@actions/core": "^1.9.1",
         "axios": "^0.27.2",
         "axios-retry": "^3.2.5",
         "espree": "^9.3.2",
@@ -17,15 +17,17 @@
       },
       "devDependencies": {
         "@vercel/ncc": "^0.34.0",
-        "jest": "^28.1.1"
+        "jest": "^28.1.1",
+        "prettier": "^2.7.1"
       }
     },
     "node_modules/@actions/core": {
-      "version": "1.8.2",
+      "version": "1.9.1",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.8.2.tgz",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.1.tgz",
-      "integrity": "sha512-FXcBL7nyik8K5ODeCKlxi+vts7torOkoDAKfeh61EAkAy1HAvwn9uVzZBY0f15YcQTcZZ2/iSGBFHEuioZWfDA==",
+      "integrity": "sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==",
       "dependencies": {
-        "@actions/http-client": "^2.0.1"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
       }
     },
     "node_modules/@actions/http-client": {
@@ -3041,6 +3043,21 @@
         "node": ">=8"
       }
     },
+    "node_modules/prettier": {
+      "version": "2.7.1",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+      "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
+      "dev": true,
+      "bin": {
+        "prettier": "bin-prettier.js"
+      },
+      "engines": {
+        "node": ">=10.13.0"
+      },
+      "funding": {
+        "url": "https://github.com/prettier/prettier?sponsor=1"
+      }
+    },
     "node_modules/pretty-format": {
       "version": "28.1.1",
       "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.1.tgz",
@@ -3460,6 +3477,14 @@
         "url": "https://github.com/sponsors/sindresorhus"
       }
     },
+    "node_modules/uuid": {
+      "version": "8.3.2",
+      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
+      "bin": {
+        "uuid": "dist/bin/uuid"
+      }
+    },
     "node_modules/v8-to-istanbul": {
       "version": "9.0.0",
       "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-9.0.0.tgz",
@@ -3579,11 +3604,12 @@
   },
   "dependencies": {
     "@actions/core": {
-      "version": "1.8.2",
+      "version": "1.9.1",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.8.2.tgz",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.1.tgz",
-      "integrity": "sha512-FXcBL7nyik8K5ODeCKlxi+vts7torOkoDAKfeh61EAkAy1HAvwn9uVzZBY0f15YcQTcZZ2/iSGBFHEuioZWfDA==",
+      "integrity": "sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==",
       "requires": {
-        "@actions/http-client": "^2.0.1"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
       }
     },
     "@actions/http-client": {
@@ -5878,6 +5904,12 @@
         "find-up": "^4.0.0"
       }
     },
+    "prettier": {
+      "version": "2.7.1",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+      "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
+      "dev": true
+    },
     "pretty-format": {
       "version": "28.1.1",
       "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.1.tgz",
@@ -6185,6 +6217,11 @@
       "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==",
       "dev": true
     },
+    "uuid": {
+      "version": "8.3.2",
+      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="
+    },
     "v8-to-istanbul": {
       "version": "9.0.0",
       "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-9.0.0.tgz",

package.json

@@ -1,24 +1,27 @@
 {
+  "private": true,
   "name": "configure-pages",
   "version": "1.0.0",
-  "description": "",
+  "description": "A GitHub Action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as starter workflows.",
-  "main": "src/index.js",
+  "main": "./dist/index.js",
   "scripts": {
-    "prepare": "ncc build src/index.js -o dist --source-map --license licenses.txt",
+    "format": "prettier --write 'src/**/*.js'",
+    "format:check": "prettier --check 'src/**/*.js'",
+    "prepare": "npm run format && ncc build src/index.js -o dist --source-map --license licenses.txt",
     "test": "jest"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/paper-spa/configure-pages.git"
+    "url": "git+https://github.com/actions/configure-pages.git"
   },
   "author": "GitHub",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/paper-spa/configure-pages/issues"
+    "url": "https://github.com/actions/configure-pages/issues"
   },
-  "homepage": "https://github.com/paper-spa/configure-pages#readme",
+  "homepage": "https://github.com/actions/configure-pages#readme",
   "dependencies": {
-    "@actions/core": "^1.8.2",
+    "@actions/core": "^1.9.1",
     "axios": "^0.27.2",
     "axios-retry": "^3.2.5",
     "espree": "^9.3.2",
@@ -26,6 +29,7 @@
   },
   "devDependencies": {
     "@vercel/ncc": "^0.34.0",
-    "jest": "^28.1.1"
+    "jest": "^28.1.1",
+    "prettier": "^2.7.1"
   }
 }

src/api-client.js

@@ -0,0 +1,91 @@
+const axios = require('axios')
+const core = require('@actions/core')
+
+function getApiBaseUrl() {
+  return process.env.GITHUB_API_URL || 'https://api.github.com'
+}
+
+async function enablePagesSite({ repositoryNwo, githubToken }) {
+  const pagesEndpoint = `${getApiBaseUrl()}/repos/${repositoryNwo}/pages`
+
+  try {
+    const response = await axios.post(
+      pagesEndpoint,
+      { build_type: 'workflow' },
+      {
+        headers: {
+          Accept: 'application/vnd.github.v3+json',
+          Authorization: `Bearer ${githubToken}`,
+          'Content-type': 'application/json'
+        }
+      }
+    )
+
+    const pageObject = response.data
+    return pageObject
+  } catch (error) {
+    if (error.response && error.response.status === 409) {
+      return null
+    }
+
+    throw error
+  }
+}
+
+async function getPagesSite({ repositoryNwo, githubToken }) {
+  try {
+    const pagesEndpoint = `${getApiBaseUrl()}/repos/${repositoryNwo}/pages`
+
+    const response = await axios.get(pagesEndpoint, {
+      headers: {
+        Accept: 'application/vnd.github.v3+json',
+        Authorization: `Bearer ${githubToken}`
+      }
+    })
+
+    const pageObject = response.data
+    return pageObject
+  } catch (error) {
+    throw error
+  }
+}
+
+async function findOrCreatePagesSite({ repositoryNwo, githubToken, enablement = true }) {
+  let pageObject
+
+  // Try to find an existing Pages site first
+  try {
+    pageObject = await getPagesSite({ repositoryNwo, githubToken })
+  } catch (error) {
+    if (!enablement) {
+      core.error('Get Pages site failed', error)
+      throw error
+    }
+    core.warning('Get Pages site failed', error)
+  }
+
+  if (!pageObject && enablement) {
+    // Create a new Pages site if one doesn't exist
+    try {
+      pageObject = await enablePagesSite({ repositoryNwo, githubToken })
+    } catch (error) {
+      core.error('Create Pages site failed', error)
+      throw error
+    }
+
+    // This somehow implies that the Pages site was already created but initially failed to be retrieved.
+    // Try one more time for this extreme edge case!
+    if (pageObject == null) {
+      try {
+        pageObject = await getPagesSite({ repositoryNwo, githubToken })
+      } catch (error) {
+        core.error('Get Pages site still failed', error)
+        throw error
+      }
+    }
+  }
+
+  return pageObject
+}
+
+module.exports = { findOrCreatePagesSite, enablePagesSite, getPagesSite, getApiBaseUrl }

src/api-client.test.js

@@ -0,0 +1,215 @@
+const core = require('@actions/core')
+const axios = require('axios')
+
+const apiClient = require('./api-client')
+
+describe('apiClient', () => {
+  const GITHUB_REPOSITORY = 'actions/is-awesome'
+  const GITHUB_TOKEN = 'gha-token'
+  const PAGE_OBJECT = { html_url: 'https://actions.github.io/is-awesome/' }
+
+  beforeEach(() => {
+    jest.restoreAllMocks()
+
+    // Mock error/warning/info/debug
+    jest.spyOn(core, 'error').mockImplementation(jest.fn())
+    jest.spyOn(core, 'warning').mockImplementation(jest.fn())
+    jest.spyOn(core, 'info').mockImplementation(jest.fn())
+    jest.spyOn(core, 'debug').mockImplementation(jest.fn())
+  })
+
+  describe('getApiBaseUrl', () => {
+    it('returns GITHUB_API_URL environment variable when set', async () => {
+      const expectedBaseUrl = 'https://api.ghe.com'
+      process.env.GITHUB_API_URL = expectedBaseUrl
+      const result = apiClient.getApiBaseUrl()
+      delete process.env.GITHUB_API_URL
+      expect(result).toEqual(expectedBaseUrl)
+    })
+
+    it('defaults to GitHub API if GITHUB_API_URL environment variable is empty', async () => {
+      process.env.GITHUB_API_URL = ''
+      const result = apiClient.getApiBaseUrl()
+      delete process.env.GITHUB_API_URL
+      expect(result).toEqual('https://api.github.com')
+    })
+
+    it('defaults to GitHub API if GITHUB_API_URL environment variable is not set', async () => {
+      delete process.env.GITHUB_API_URL
+      const result = apiClient.getApiBaseUrl()
+      expect(result).toEqual('https://api.github.com')
+    })
+  })
+
+  describe('enablePagesSite', () => {
+    it('makes a request to create a page', async () => {
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.resolve({ status: 201, data: PAGE_OBJECT }))
+
+      const result = await apiClient.enablePagesSite({
+        repositoryNwo: GITHUB_REPOSITORY,
+        githubToken: GITHUB_TOKEN
+      })
+      expect(result).toEqual(PAGE_OBJECT)
+    })
+
+    it('handles a 409 response when the page already exists', async () => {
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.reject({ response: { status: 409 } }))
+
+      // Simply assert that no error is raised
+      const result = await apiClient.enablePagesSite({
+        repositoryNwo: GITHUB_REPOSITORY,
+        githubToken: GITHUB_TOKEN
+      })
+
+      expect(result).toBe(null)
+    })
+
+    it('re-raises errors on failure status codes', async () => {
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
+
+      let erred = false
+      try {
+        await apiClient.enablePagesSite({
+          repositoryNwo: GITHUB_REPOSITORY,
+          githubToken: GITHUB_TOKEN
+        })
+      } catch (error) {
+        erred = true
+        expect(error.response.status).toEqual(404)
+      }
+      expect(erred).toBe(true)
+    })
+  })
+
+  describe('getPagesSite', () => {
+    it('makes a request to get a page', async () => {
+      const PAGE_OBJECT = { html_url: 'https://actions.github.io/is-awesome/' }
+      jest.spyOn(axios, 'get').mockImplementationOnce(() => Promise.resolve({ status: 200, data: PAGE_OBJECT }))
+
+      const result = await apiClient.getPagesSite({
+        repositoryNwo: GITHUB_REPOSITORY,
+        githubToken: GITHUB_TOKEN
+      })
+      expect(result).toEqual(PAGE_OBJECT)
+    })
+
+    it('re-raises errors on failure status codes', async () => {
+      jest.spyOn(axios, 'get').mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
+
+      let erred = false
+      try {
+        await apiClient.getPagesSite({
+          repositoryNwo: GITHUB_REPOSITORY,
+          githubToken: GITHUB_TOKEN
+        })
+      } catch (error) {
+        erred = true
+        expect(error.response.status).toEqual(404)
+      }
+      expect(erred).toBe(true)
+    })
+  })
+
+  describe('findOrCreatePagesSite', () => {
+    it('does not make a request to create a page if it already exists', async () => {
+      const PAGE_OBJECT = { html_url: 'https://actions.github.io/is-awesome/' }
+      jest.spyOn(axios, 'get').mockImplementationOnce(() => Promise.resolve({ status: 200, data: PAGE_OBJECT }))
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
+
+      const result = await apiClient.findOrCreatePagesSite({
+        repositoryNwo: GITHUB_REPOSITORY,
+        githubToken: GITHUB_TOKEN
+      })
+      expect(result).toEqual(PAGE_OBJECT)
+      expect(axios.get).toHaveBeenCalledTimes(1)
+      expect(axios.post).toHaveBeenCalledTimes(0)
+    })
+
+    it('makes request to create a page by default if it does not exist', async () => {
+      const PAGE_OBJECT = { html_url: 'https://actions.github.io/is-awesome/' }
+      jest.spyOn(axios, 'get').mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.resolve({ status: 201, data: PAGE_OBJECT }))
+
+      const result = await apiClient.findOrCreatePagesSite({
+        repositoryNwo: GITHUB_REPOSITORY,
+        githubToken: GITHUB_TOKEN
+      })
+      expect(result).toEqual(PAGE_OBJECT)
+      expect(axios.get).toHaveBeenCalledTimes(1)
+      expect(axios.post).toHaveBeenCalledTimes(1)
+    })
+
+    it('makes a request to create a page when explicitly enabled if it does not exist', async () => {
+      const PAGE_OBJECT = { html_url: 'https://actions.github.io/is-awesome/' }
+      jest.spyOn(axios, 'get').mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.resolve({ status: 201, data: PAGE_OBJECT }))
+
+      const result = await apiClient.findOrCreatePagesSite({
+        repositoryNwo: GITHUB_REPOSITORY,
+        githubToken: GITHUB_TOKEN,
+        enablement: true
+      })
+      expect(result).toEqual(PAGE_OBJECT)
+      expect(axios.get).toHaveBeenCalledTimes(1)
+      expect(axios.post).toHaveBeenCalledTimes(1)
+    })
+
+    it('does not make a request to create a page when explicitly disabled even if it does not exist', async () => {
+      jest.spyOn(axios, 'get').mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.reject({ response: { status: 500 } })) // just so they both aren't 404
+
+      let erred = false
+      try {
+        await apiClient.findOrCreatePagesSite({
+          repositoryNwo: GITHUB_REPOSITORY,
+          githubToken: GITHUB_TOKEN,
+          enablement: false
+        })
+      } catch (error) {
+        erred = true
+        // re-raised error
+        expect(error.response.status).toEqual(404)
+      }
+      expect(erred).toBe(true)
+      expect(axios.get).toHaveBeenCalledTimes(1)
+      expect(axios.post).toHaveBeenCalledTimes(0)
+    })
+
+    it('does not make a second request to get page if create fails for reason other than existence', async () => {
+      jest.spyOn(axios, 'get').mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.reject({ response: { status: 500 } })) // just so they both aren't 404
+
+      let erred = false
+      try {
+        await apiClient.findOrCreatePagesSite({
+          repositoryNwo: GITHUB_REPOSITORY,
+          githubToken: GITHUB_TOKEN
+        })
+      } catch (error) {
+        erred = true
+        // re-raised error
+        expect(error.response.status).toEqual(500)
+      }
+      expect(erred).toBe(true)
+      expect(axios.get).toHaveBeenCalledTimes(1)
+      expect(axios.post).toHaveBeenCalledTimes(1)
+    })
+
+    it('makes second request to get page if create fails because of existence', async () => {
+      const PAGE_OBJECT = { html_url: 'https://actions.github.io/is-awesome/' }
+      jest
+        .spyOn(axios, 'get')
+        .mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
+        .mockImplementationOnce(() => Promise.resolve({ status: 200, data: PAGE_OBJECT }))
+      jest.spyOn(axios, 'post').mockImplementationOnce(() => Promise.reject({ response: { status: 409 } }))
+
+      const result = await apiClient.findOrCreatePagesSite({
+        repositoryNwo: GITHUB_REPOSITORY,
+        githubToken: GITHUB_TOKEN
+      })
+      expect(result).toEqual(PAGE_OBJECT)
+      expect(axios.get).toHaveBeenCalledTimes(2)
+      expect(axios.post).toHaveBeenCalledTimes(1)
+    })
+  })
+})

src/blank-configurations/gatsby.js

@@ -0,0 +1,2 @@
+// Default Pages configuration for Gatsby
+module.exports = {}

src/blank-configurations/next.js

@@ -0,0 +1,3 @@
+// Default Pages configuration for Next
+const nextConfig = {}
+module.exports = nextConfig

src/blank-configurations/nuxt.js

@@ -0,0 +1,2 @@
+// Default Pages configuration for Nuxt
+export default {}

src/blank-configurations/sveltekit.js

@@ -0,0 +1,8 @@
+// Default Pages configuration for SvelteKit
+import adapter from '@sveltejs/adapter-auto'
+
+export default {
+  kit: {
+    adapter: adapter()
+  }
+}

src/config-parser.js

@@ -1,156 +1,278 @@
-const fs = require("fs")
+const fs = require('fs')
-const espree = require("espree")
+const espree = require('espree')
-const format = require("string-format")
 const core = require('@actions/core')
 
-// Parse the AST
+/*
-const espreeOptions = {
+Parse a JavaScript based configuration file and inject arbitrary key/value in it.
-  ecmaVersion: 6,
+This is used to make sure most static site generators can automatically handle
-  sourceType: "module",
+Pages's path based routing (and work).
-  range: true,
+
-}
+Supported configuration initializations:
+
+(1) Default export:
+
+  export default {
+    // configuration object here
+  }
+
+(2) Direct module export:
+
+  module.exports = {
+    // configuration object here
+  }
+
+(3) Indirect module export:
+
+  const config = // configuration object here
+  module.exports = config
+*/
 
 class ConfigParser {
-  constructor(staticSiteConfig) {
+  // Ctor
-    this.pathPropertyNuxt = `router: {\n        base: '{0}'\n    }`
+  // - configurationFile: path to the configuration file
-    this.pathPropertyNext = `basePath: '{0}'`
+  // - blankConfigurationFile: a blank configuration file to use if non was previously found
-    this.pathPropertyGatsby = `pathPrefix: '{0}'`
+  constructor({ configurationFile, blankConfigurationFile, properties }) {
-    this.configskeleton = `export default {\n    {0}\n}`
+    // Save field
-    this.staticSiteConfig = staticSiteConfig
+    this.configurationFile = configurationFile
-    this.config = fs.existsSync(this.staticSiteConfig.filePath) ? fs.readFileSync(this.staticSiteConfig.filePath, "utf8") : null
+    this.properties = properties
-    this.validate()
-  }
 
-  validate() {
+    // If the configuration file does not exist, initialize it with the blank configuration file
-    if (!this.config) {
+    if (!fs.existsSync(this.configurationFile)) {
-      core.info(`original raw configuration was empty:\n${this.config}`)
+      core.info('Using default blank configuration')
-      core.info('Generating a default configuration to start from...')
+      const blankConfiguration = fs.readFileSync(blankConfigurationFile, 'utf8')
-
+      fs.writeFileSync(this.configurationFile, blankConfiguration, {
-      // Update the `config` property with a default configuration file
+        encoding: 'utf8'
-      this.config = this.generateConfigFile()
+      })
-    }
-  }
-
-  generateConfigFile() {
-    switch (this.staticSiteConfig.type) {
-      case "nuxt":
-        return format(this.configskeleton, format(this.pathPropertyNuxt, this.staticSiteConfig.newPath))
-        break
-      case "next":
-        return format(this.configskeleton, format(this.pathPropertyNext, this.staticSiteConfig.newPath))
-        break
-      case "gatsby":
-        return format(this.configskeleton, format(this.pathPropertyGatsby, this.staticSiteConfig.newPath))
-        break
-      default:
-        throw "Unknown config type"
-    }
-  }
-
-  generateConfigProperty() {
-    switch (this.staticSiteConfig.type) {
-      case "nuxt":
-        return format(this.pathPropertyNuxt, this.staticSiteConfig.newPath)
-        break
-      case "next":
-        return format(this.pathPropertyNext, this.staticSiteConfig.newPath)
-        break
-      case "gatsby":
-        return format(this.pathPropertyGatsby, this.staticSiteConfig.newPath)
-        break
-      default:
-        throw "Unknown config type"
-    }
-  }
-
-  parse() {
-    core.info(`original configuration:\n${this.config}`)
-    const ast = espree.parse(this.config, espreeOptions);
-
-    // Find the default export declaration node
-    var exportNode = ast.body.find(node => node.type === 'ExpressionStatement')
-    if (exportNode) {
-      var property = this.getPropertyModuleExport(exportNode)
-
-    } else {
-      exportNode = ast.body.find(node => node.type === 'ExportDefaultDeclaration')
-      if (!exportNode) throw "Unable to find default export"
-      var property = this.getPropertyExportDefault(exportNode)
     }
 
+    // Read the configuration file
+    this.configuration = fs.readFileSync(this.configurationFile, 'utf8')
+  }
+
+  // Find the configuration object in an AST.
+  // Look for a default export, a direct module export or an indirect module
+  // export (in that order).
+  //
+  // Return the configuration object or null.
+  findConfigurationObject(ast) {
+    // Try to find a default export
+    var defaultExport = ast.body.find(node => node.type === 'ExportDefaultDeclaration')
+
+    // Direct default export
+    if (defaultExport && defaultExport.declaration.type === 'ObjectExpression') {
+      core.info('Found configuration object in direct default export declaration')
+      return defaultExport.declaration
+    }
+
+    // Indirect default export
+    else if (defaultExport && defaultExport.declaration.type === 'Identifier') {
+      const identifierName = defaultExport.declaration.name
+      const identifierDefinition = ast.body.find(
+        node =>
+          node.type === 'VariableDeclaration' &&
+          node.declarations.length == 1 &&
+          node.declarations[0].type === 'VariableDeclarator' &&
+          node.declarations[0].id.type === 'Identifier' &&
+          node.declarations[0].id.name === identifierName &&
+          node.declarations[0].init.type === 'ObjectExpression'
+      )
+      if (identifierDefinition) {
+        core.info('Found configuration object in indirect default export declaration')
+        return identifierDefinition.declarations[0].init
+      }
+    }
+
+    // Try to find a module export
+    var moduleExport = ast.body.find(
+      node =>
+        node.type === 'ExpressionStatement' &&
+        node.expression.type === 'AssignmentExpression' &&
+        node.expression.operator === '=' &&
+        node.expression.left.type === 'MemberExpression' &&
+        node.expression.left.object.type === 'Identifier' &&
+        node.expression.left.object.name === 'module' &&
+        node.expression.left.property.type === 'Identifier' &&
+        node.expression.left.property.name === 'exports'
+    )
+
+    // Direct module export
+    if (moduleExport && moduleExport.expression.right.type === 'ObjectExpression') {
+      core.info('Found configuration object in direct module export')
+      return moduleExport.expression.right
+    }
+
+    // Indirect module export
+    else if (moduleExport && moduleExport.expression.right.type === 'Identifier') {
+      const identifierName = moduleExport && moduleExport.expression.right.name
+      const identifierDefinition = ast.body.find(
+        node =>
+          node.type === 'VariableDeclaration' &&
+          node.declarations.length == 1 &&
+          node.declarations[0].type === 'VariableDeclarator' &&
+          node.declarations[0].id.type === 'Identifier' &&
+          node.declarations[0].id.name === identifierName &&
+          node.declarations[0].init.type === 'ObjectExpression'
+      )
+      if (identifierDefinition) {
+        core.info('Found configuration object in indirect module export')
+        return identifierDefinition.declarations[0].init
+      }
+    }
+
+    // No configuration object found
+    return null
+  }
+
+  // Find a property with a given name on a given object.
+  //
+  // Return the matching property or null.
+  findProperty(object, name) {
+    // Try to find a property matching a given name
+    const property =
+      object.type === 'ObjectExpression' &&
+      object.properties.find(node => node.key.type === 'Identifier' && node.key.name === name)
+
+    // Return the property's value (if found) or null
     if (property) {
-      switch (this.staticSiteConfig.type) {
+      return property.value
-        case "nuxt":
-          this.parseNuxt(property)
-          break
-        case "next":
-        case "gatsby":
-          this.parseNextGatsby(property)
-          break
-        default:
-          throw "Unknown config type"
-      }
     }
-    core.info(`parsed configuration:\n${this.config}`)
+    return null
-    fs.writeFileSync(this.staticSiteConfig.filePath, this.config)
-    return this.config
   }
 
-  getPropertyModuleExport(exportNode) {
+  // Generate a (nested) property declaration.
-    var propertyNode = exportNode.expression.right.properties.find(
+  // - properties: list of properties to generate
-      node => node.key.type === 'Identifier' && node.key.name === this.staticSiteConfig.pathName
+  // - startIndex: the index at which to start in the declaration
-    )
+  // - propertyValue: the value of the property
-
+  //
-    if (!propertyNode) {
+  // Return a nested property declaration as a string.
-
+  getPropertyDeclaration(properties, startIndex, propertyValue) {
-      core.info("Unable to find property, insert it :  " + this.staticSiteConfig.pathName)
+    if (startIndex === properties.length - 1) {
-      if (exportNode.expression.right.properties.length > 0) {
+      return `${properties[startIndex]}: ${JSON.stringify(propertyValue)}`
-       this.config = this.config.slice(0, exportNode.expression.right.properties[0].range[0]) + this.generateConfigProperty() + ',\n' + this.config.slice(exportNode.expression.right.properties[0].range[0])
+    } else {
-        core.info("new config = \n" + this.config)
+      return (
-      } else {
+        `${properties[startIndex]}: {` + this.getPropertyDeclaration(properties, startIndex + 1, propertyValue) + '}'
-       this.config = this.config.slice(0, exportNode.expression.right.range[0] + 1) + '\n    ' + this.generateConfigProperty() + '\n' + this.config.slice(exportNode.expression.right.range[1] - 1)
+      )
-        core.info("new config = \n" + this.config)
-      }
-    }
-    return propertyNode
-  }
-
-  getPropertyExportDefault(exportNode) {
-    var propertyNode = exportNode.declaration.properties.find(
-      node => node.key.type === 'Identifier' && node.key.name === this.staticSiteConfig.pathName
-    )
-
-    if (!propertyNode) {
-
-      core.info("Unable to find property, insert it " + this.staticSiteConfig.pathName)
-      if (exportNode.declaration.properties.length > 0) {
-        this.config = this.config.slice(0, exportNode.declaration.properties[0].range[0]) + this.generateConfigProperty() + ',\n' + this.config.slice(exportNode.declaration.properties[0].range[0])
-        core.info("new config = \n" + this.config)
-      } else {
-        this.config = this.config.slice(0, exportNode.declaration.range[0] + 1) + '\n    ' + this.generateConfigProperty() + '\n' + this.config.slice(exportNode.declaration.range[1] - 1)
-        core.info("new config = \n" + this.config)
-      }
-    }
-
-    return propertyNode
-  }
-
-  parseNuxt(propertyNode) {
-    // Find the base node
-    if (propertyNode && propertyNode.value.type === 'ObjectExpression') {
-      var baseNode = propertyNode.value.properties.find(node => node.key.type === 'Identifier' && node.key.name === this.staticSiteConfig.subPathName)//'base')
-      if (baseNode) {
-        // Swap the base value by a hardcoded string and print it
-        this.config = this.config.slice(0, baseNode.value.range[0]) + `'${this.staticSiteConfig.newPath}'` + this.config.slice(baseNode.value.range[1])
-      }
     }
   }
 
-  parseNextGatsby(pathNode) {
+  // Inject all properties into the configuration
-    if (pathNode) {
+  injectAll() {
-      this.config = this.config.slice(0, pathNode.value.range[0]) + `'${this.staticSiteConfig.newPath}'` + this.config.slice(pathNode.value.range[1])
+    for (var [propertyName, propertyValue] of Object.entries(this.properties)) {
+      this.inject(propertyName, propertyValue)
     }
   }
+
+  // Inject an arbitrary property into the configuration
+  // - propertyName: the name of the property (may use . to target nested objects)
+  // - propertyValue: the value of the property
+  inject(propertyName, propertyValue) {
+    // Logging
+    core.info(`Injecting property=${propertyName} and value=${propertyValue} in:`)
+    core.info(this.configuration)
+
+    // Parse the AST out of the configuration file
+    const espreeOptions = {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      range: true
+    }
+    const ast = espree.parse(this.configuration, espreeOptions)
+
+    // Find the configuration object
+    var configurationObject = this.findConfigurationObject(ast)
+    if (!configurationObject) {
+      throw 'Could not find a configuration object in the configuration file'
+    }
+
+    // A property may be nested in the configuration file. Split the property name with `.`
+    // then walk the configuration object one property at a time.
+    var depth = 0
+    const properties = propertyName.split('.')
+    var lastNode = configurationObject
+    while (true) {
+      // Find the node for the current property
+      var propertyNode = this.findProperty(lastNode, properties[depth])
+
+      // Update last node
+      if (propertyNode != null) {
+        lastNode = propertyNode
+        depth++
+      }
+
+      // Exit when exiting the current configuration object
+      if (propertyNode == null || depth >= properties.length) {
+        break
+      }
+    }
+
+    // If the configuration file is defining the property we are after, update it.
+    if (depth == properties.length) {
+      // The last node identified is an object expression, so do the assignment
+      if (lastNode.type === 'ObjectExpression') {
+        this.configuration =
+          this.configuration.slice(0, lastNode.range[0]) +
+          JSON.stringify(propertyValue) +
+          this.configuration.slice(lastNode.range[1])
+      }
+
+      // A misc object was found in the configuration file (e.g. an array, a string, a boolean,
+      // a number, etc.), just replace the whole range by our declaration
+      else {
+        this.configuration =
+          this.configuration.slice(0, lastNode.range[0]) +
+          JSON.stringify(propertyValue) +
+          this.configuration.slice(lastNode.range[1])
+      }
+    }
+
+    // Create nested properties in the configuration file
+    else {
+      // Build the declaration to inject
+      const declaration = this.getPropertyDeclaration(properties, depth, propertyValue)
+
+      // The last node identified is an object expression, so do the assignment
+      if (lastNode.type === 'ObjectExpression') {
+        // The object is blank (no properties) so replace the whole range by a new object containing the declaration
+        if (lastNode.properties.length === 0) {
+          this.configuration =
+            this.configuration.slice(0, lastNode.range[0]) +
+            '{' +
+            declaration +
+            '}' +
+            this.configuration.slice(lastNode.range[1])
+        }
+
+        // The object contains other properties, prepend our new one at the beginning
+        else {
+          this.configuration =
+            this.configuration.slice(0, lastNode.properties[0].range[0]) +
+            declaration +
+            ',' +
+            this.configuration.slice(lastNode.properties[0].range[0])
+        }
+      }
+
+      // A misc object was found in the configuration file (e.g. an array, a string, a boolean,
+      // a number, etc.), just replace the whole range by our declaration
+      else {
+        this.configuration =
+          this.configuration.slice(0, lastNode.range[0]) +
+          '{' +
+          declaration +
+          '}' +
+          this.configuration.slice(lastNode.range[1])
+      }
+    }
+
+    // Logging
+    core.info(`Injection successful, new configuration:`)
+    core.info(this.configuration)
+
+    // Finally write the new configuration in the file
+    fs.writeFileSync(this.configurationFile, this.configuration, {
+      encoding: 'utf8'
+    })
+  }
 }
 
-module.exports = {ConfigParser}
+module.exports = { ConfigParser }

src/config-parser.test.js

@@ -1,83 +1,190 @@
+const fs = require('fs')
+const core = require('@actions/core')
+
 const { ConfigParser } = require('./config-parser')
-const fs = require("fs")
+const { getTempFolder, compareFiles } = require('./test-helpers')
-const assert = require('assert')
 
-const srcFolder = `${process.cwd()}/src/fixtures`
+// Get the temp folder
-const tmpFolder = `${process.cwd()}/src/fixtures/tmp`
+const tempFolder = getTempFolder()
-const expectedFolder = `${process.cwd()}/src/fixtures/expected`
-
-const repoPath = "/amazing-new-repo/"
 
+// Cases to test
 const cases = [
-  ["next.config.js", {
+  //
-    filePath: `${tmpFolder}/next.config.js`,
+  // Default export
-    type: "next",
+  //
-    pathName: "basePath",
+  {
-    newPath: repoPath
+    property: 'property',
-  }],
+    source: `export default {}`,
-  ["next.config.old.js", {
+    expected: `export default { property: "value" }`
-    filePath: `${tmpFolder}/next.config.old.js`,
+  },
-    type: "next",
+  {
-    pathName: "basePath",
+    property: 'property',
-    newPath: repoPath
+    source: `export default { property: 0 }`, // property exists and is a number
-  }],
+    expected: `export default { property: "value" }`
-  ["next.config.old.missing.js", {
+  },
-    filePath: `${tmpFolder}/next.config.old.missing.js`,
+  {
-    type: "next",
+    property: 'property',
-    pathName: "basePath",
+    source: `export default { property: false }`, // property exists and is a boolean
-    newPath: repoPath
+    expected: `export default { property: "value" }`
-  }],
+  },
-  ["gatsby-config.js", {
+  {
-    filePath: `${tmpFolder}/gatsby-config.js`,
+    property: 'property',
-    type: "gatsby",
+    source: `export default { property: "test" }`, // property exists and is a string
-    pathName: "pathPrefix",
+    expected: `export default { property: "value" }`
-    newPath: repoPath
+  },
-  }],
+  {
-  ["gatsby-config.old.js", {
+    property: 'property',
-    filePath: `${tmpFolder}/gatsby-config.old.js`,
+    source: `export default { property: [1,2] }`, // property exists and is an array
-    type: "gatsby",
+    expected: `export default { property: "value" }`
-    pathName: "pathPrefix",
+  },
-    newPath: repoPath
+  {
-  }],
+    property: 'property',
-  ["nuxt.config.js", {
+    source: `export default { property: null }`, // property exists and is null
-    filePath:`${tmpFolder}/nuxt.config.js`,
+    expected: `export default { property: "value" }`
-    type: "nuxt",
+  },
-    pathName: "router",
+  {
-    subPathName: "base",
+    property: 'property',
-    newPath: repoPath
+    source: `export default { property: {}}`, // property exists and is an object
-  }],
+    expected: `export default { property: "value" }`
-  ["nuxt.config.missing.js", {
+  },
-    filePath:`${tmpFolder}/nuxt.config.missing.js`,
-    type: "nuxt",
-    pathName: "router",
-    subPathName: "base",
-    newPath: repoPath
-  }],
-  ["nuxt.config.old.js", {
-    filePath:`${tmpFolder}/nuxt.config.old.js`,
-    type: "nuxt",
-    pathName: "router",
-    subPathName: "base",
-    newPath: repoPath
-  }],
-];
 
-describe('configParser', () => {
+  // Deep properties (injection 1)
-  test.each(cases)(
+  {
-    "%p parsed correctly",
+    property: 'property.b.c',
-    (fileName, configuration) => {
+    source: `export default {}`,
-      srcFileName = `${srcFolder}/${fileName}`
+    expected: `export default { property: { b: { c: "value" }}}`
-      tmpFileName = `${tmpFolder}/${fileName}`
+  },
-      expectedFileName = `${expectedFolder}/${fileName}`
+  {
-      fs.mkdirSync(tmpFolder, {recursive: true})
+    property: 'property.b.c',
-      fs.copyFileSync(srcFileName, tmpFileName)
+    source: `export default { property: 0 }`, // property exists and is a number
-      const parser = new ConfigParser(configuration)
+    expected: `export default { property: { b: { c: "value" }}}`
-      parser.parse()
+  },
+  {
+    property: 'property.b.c',
+    source: `export default { property: {}}`, // property exists and is an object
+    expected: `export default { property: { b: { c: "value" }}}`
+  },
 
-      var expectedContent = fs.readFileSync(expectedFileName).toString()
+  // Deep properties (injection 2)
-      var actualContent = fs.readFileSync(tmpFileName).toString()
+  {
-      assert.equal(actualContent, expectedContent)
+    property: 'property.b.c',
-      fs.rmSync(tmpFileName)
+    source: `export default { property: { b: 0 }}`, // property exists and is a number
-    }
+    expected: `export default { property: { b: { c: "value" }}}`
-  )
+  },
+  {
+    property: 'property.b.c',
+    source: `export default { property: { b: {}}}`, // property exists and is an object
+    expected: `export default { property: { b: { c: "value" }}}`
+  },
+  {
+    property: 'property.b.c',
+    source: `export default { property: { b: { hello: 123}}}`, // property exists and is a non-empty object
+    expected: `export default { property: { b: { c: "value", hello: 123 }}}`
+  },
+
+  // Deep properties (existing properties)
+  {
+    property: 'a1.a2',
+    source: `export default { a2: false, a1: { a3: [12]}}`, // property exists and is a non-empty object
+    expected: `export default { a2: false, a1: { a2: "value", a3: [12]}}`
+  },
+
+  //
+  // Indirect default export
+  //
+  {
+    property: 'property',
+    source: `const config = {}; export default config`,
+    expected: `const config = { property: "value"}; export default config`
+  },
+  {
+    property: 'property',
+    source: `var config = {}; export default config`,
+    expected: `var config = { property: "value"}; export default config`
+  },
+  {
+    property: 'a.b.c',
+    source: `var config = {}; export default config`,
+    expected: `var config = { a: { b: { c: "value"}}}; export default config`
+  },
+  {
+    property: 'a.b.c',
+    source: `var config = { a: { b: [], c: "hello"}}; export default config`,
+    expected: `var config = { a: { b: { c: "value"}, c: "hello"}}; export default config`
+  },
+
+  //
+  // Direct module exports
+  //
+  {
+    property: 'property',
+    source: `module.exports = {}`,
+    expected: `module.exports = { property: "value"}`
+  },
+  {
+    property: 'property',
+    source: `module.exports = { p1: 0}`,
+    expected: `module.exports = { property: "value", p1: 0}`
+  },
+  {
+    property: 'a.b.c',
+    source: `module.exports = { p1: 0}`,
+    expected: `module.exports = { a: { b: { c: "value" }}, p1: 0}`
+  },
+
+  //
+  // Indirect module exports
+  //
+  {
+    property: 'property',
+    source: `const config = {}; module.exports = config`,
+    expected: `const config = { property: "value"}; module.exports = config`
+  },
+  {
+    property: 'property',
+    source: `var config = {}; module.exports = config`,
+    expected: `var config = { property: "value"}; module.exports = config`
+  },
+  {
+    property: 'a.b.c',
+    source: `var config = {}; module.exports = config`,
+    expected: `var config = { a: { b: { c: "value"}}}; module.exports = config`
+  },
+  {
+    property: 'a.b.c',
+    source: `var config = { a: { b: [], c: "hello"}}; module.exports = config`,
+    expected: `var config = { a: { b: { c: "value"}, c: "hello"}}; module.exports = config`
+  }
+]
+
+describe('config-parser', () => {
+  beforeEach(() => {
+    jest.restoreAllMocks()
+
+    // Mock error/warning/info/debug to silence their output
+    jest.spyOn(core, 'error').mockImplementation(jest.fn())
+    jest.spyOn(core, 'warning').mockImplementation(jest.fn())
+    jest.spyOn(core, 'info').mockImplementation(jest.fn())
+    jest.spyOn(core, 'debug').mockImplementation(jest.fn())
+  })
+
+  cases.forEach(({ property, source, expected }, index) => {
+    it(`injects path properly for case #${index}`, () => {
+      // Write the source file
+      const sourceFile = `${tempFolder}/source.js`
+      fs.writeFileSync(sourceFile, source, { encoding: 'utf8' })
+
+      // Write the expected file
+      const expectedFile = `${tempFolder}/expected.js`
+      fs.writeFileSync(expectedFile, expected, { encoding: 'utf8' })
+
+      // Update the settings and do the injection
+      new ConfigParser({
+        configurationFile: sourceFile
+      }).inject(property, 'value')
+
+      // Compare the files
+      compareFiles(sourceFile, expectedFile)
+    })
+  })
 })

src/context.js

@@ -5,11 +5,14 @@ function getRequiredVars() {
   return {
     repositoryNwo: process.env.GITHUB_REPOSITORY,
     githubToken: core.getInput('token'),
-    staticSiteGenerator: core.getInput('static_site_generator')
+    staticSiteGenerator: core.getInput('static_site_generator'),
+    generatorConfigFile: core.getInput('generator_config_file'),
+    enablement: core.getInput('enablement') !== 'false'
   }
 }
 
-module.exports = function getContext() {
+// Return the context object
+function getContext() {
   const requiredVars = getRequiredVars()
   for (const variable in requiredVars) {
     if (requiredVars[variable] === undefined) {
@@ -19,3 +22,5 @@ module.exports = function getContext() {
   core.debug('all variables are set')
   return requiredVars
 }
+
+module.exports = { getContext }

src/enable-pages.js

@@ -1,31 +0,0 @@
-const core = require('@actions/core')
-const axios = require('axios')
-
-async function enablePages({ repositoryNwo, githubToken }) {
-  const pagesEndpoint = `https://api.github.com/repos/${repositoryNwo}/pages`
-
-  try {
-    const response = await axios.post(
-      pagesEndpoint,
-      { build_type: 'workflow' },
-      {
-        headers: {
-          Accept: 'application/vnd.github.v3+json',
-          Authorization: `Bearer ${githubToken}`,
-          'Content-type': 'application/json',
-        },
-      }
-    )
-    core.info('Created pages site')
-  } catch (error) {
-    if (error.response && error.response.status === 409) {
-      core.info('Pages site exists')
-      return
-    }
-
-    core.error('Couldn\'t create pages site', error)
-    throw error
-  }
-}
-
-module.exports = enablePages

src/enable-pages.test.js

@@ -1,48 +0,0 @@
-const core = require('@actions/core')
-const axios = require('axios')
-
-const enablePages = require('./enable-pages')
-
-describe('enablePages', () => {
-  const GITHUB_REPOSITORY = 'paper-spa/is-awesome'
-  const GITHUB_TOKEN = 'gha-token'
-
-  beforeEach(() => {
-    jest.restoreAllMocks()
-
-    // Mock error/warning/info/debug
-    jest.spyOn(core, 'error').mockImplementation(jest.fn())
-    jest.spyOn(core, 'warning').mockImplementation(jest.fn())
-    jest.spyOn(core, 'info').mockImplementation(jest.fn())
-    jest.spyOn(core, 'debug').mockImplementation(jest.fn())
-  })
-
-  it('makes a request to create a page', async () => {
-    jest
-      .spyOn(axios, 'post')
-      .mockImplementationOnce(() => Promise.resolve({  }))
-
-    await enablePages({ repositoryNwo: GITHUB_REPOSITORY, githubToken: GITHUB_TOKEN })
-  })
-
-  it('handles a 409 response when the page already exists', async () => {
-    jest
-      .spyOn(axios, 'post')
-      .mockImplementationOnce(() => Promise.reject({ response: { status: 409 } }))
-
-    // Simply assert that no error is raised
-    await enablePages({ repositoryNwo: GITHUB_REPOSITORY, githubToken: GITHUB_TOKEN })
-  })
-
-  it('re-raises errors on failure status codes', async () => {
-    jest
-      .spyOn(axios, 'post')
-      .mockImplementationOnce(() => Promise.reject({ response: { status: 404 } }))
-
-    try {
-      await enablePages({ repositoryNwo: GITHUB_REPOSITORY, githubToken: GITHUB_TOKEN })
-    } catch (error) {
-      expect(error.response.status).toEqual(404)
-    }
-  })
-})

src/fixtures/expected/gatsby-config.js

@@ -1,8 +0,0 @@
-import { resolve } from 'path'
-
-export default {
-  alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  pathPrefix: '/amazing-new-repo/',/* test */
-}

src/fixtures/expected/gatsby-config.old.js

@@ -1,3 +0,0 @@
-module.exports = {
-  pathPrefix: '/amazing-new-repo/'
-}

src/fixtures/expected/next.config.js

@@ -1,9 +0,0 @@
-
-import { resolve } from 'path'
-
-export default {
-  alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  basePath: '/amazing-new-repo/'/* test */,
-}

src/fixtures/expected/next.config.old.js

@@ -1,4 +0,0 @@
-module.exports={
-    basePath: '/amazing-new-repo/'/* test */,
-  }
-  

src/fixtures/expected/next.config.old.missing.js

@@ -1,4 +0,0 @@
-module.exports={
-    basePath: '/amazing-new-repo/'
-}
-  

src/fixtures/expected/nuxt.config.js

@@ -1,11 +0,0 @@
-import { resolve } from 'path'
-
-export default {
-  alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  target: 'static',
-  router: {
-    base: '/amazing-new-repo/'
-  }
-}

src/fixtures/expected/nuxt.config.missing.js

@@ -1,11 +0,0 @@
-import { resolve } from 'path'
-
-export default {
-  router: {
-        base: '/amazing-new-repo/'
-    },
-alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  target: 'static'
-}

src/fixtures/expected/nuxt.config.old.js

@@ -1,10 +0,0 @@
-
-module.exports={
-  alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  target: 'static',
-  router: {
-    base: '/amazing-new-repo/'
-  }
-}

src/fixtures/gatsby-config.js

@@ -1,8 +0,0 @@
-import { resolve } from 'path'
-
-export default {
-  alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  pathPrefix: '/prefix',/* test */
-}

src/fixtures/gatsby-config.old.js

@@ -1,3 +0,0 @@
-module.exports = {
-  pathPrefix: '/prefix'
-}

src/fixtures/gatsby/blank.expected.js

@@ -0,0 +1,2 @@
+// Default Pages configuration for Gatsby
+module.exports = { pathPrefix: '/docs/' }

src/fixtures/gatsby/blank.js

@@ -0,0 +1 @@
+// This file is not read by the test suite

src/fixtures/gatsby/default.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`,
+  },
+  plugins: [],
+}

src/fixtures/gatsby/default.expected.cjs

@@ -0,0 +1,8 @@
+module.exports = {
+  pathPrefix: "/docs/",
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`,
+  },
+  plugins: [],
+}

src/fixtures/gatsby/default.expected.js

@@ -0,0 +1,8 @@
+module.exports = {
+  pathPrefix: '/docs/',
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`
+  },
+  plugins: []
+}

src/fixtures/gatsby/default.expected.mjs

@@ -0,0 +1,8 @@
+export default {
+  pathPrefix: "/docs/",
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`,
+  },
+  plugins: [],
+}

src/fixtures/gatsby/default.js

@@ -0,0 +1,7 @@
+module.exports = {
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`
+  },
+  plugins: []
+}

src/fixtures/gatsby/default.mjs

@@ -0,0 +1,7 @@
+export default {
+  siteMetadata: {
+    title: `My Gatsby Site`,
+    siteUrl: `https://www.yourdomain.tld`,
+  },
+  plugins: [],
+}

src/fixtures/next.config.js

@@ -1,9 +0,0 @@
-
-import { resolve } from 'path'
-
-export default {
-  alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  basePath: '/gh-pages-test'/* test */,
-}

src/fixtures/next.config.old.js

@@ -1,4 +0,0 @@
-module.exports={
-    basePath: '/gh-pages-test'/* test */,
-  }
-  

src/fixtures/next.config.old.missing.js

@@ -1,4 +0,0 @@
-module.exports={
-
-}
-  

src/fixtures/next/blank.expected.js

@@ -0,0 +1,3 @@
+// Default Pages configuration for Next
+const nextConfig = { experimental: { images: { unoptimized: true } }, basePath: '/docs' }
+module.exports = nextConfig

src/fixtures/next/blank.js

@@ -0,0 +1 @@
+// This file is not read by the test suite

src/fixtures/next/default.cjs

@@ -0,0 +1,7 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+  swcMinify: true,
+}
+
+module.exports = nextConfig

src/fixtures/next/default.expected.cjs

@@ -0,0 +1,9 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {images: {unoptimized: true}},
+  basePath: '/docs',
+  reactStrictMode: true,
+  swcMinify: true
+}
+
+module.exports = nextConfig

src/fixtures/next/default.expected.js

@@ -0,0 +1,9 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: { images: { unoptimized: true } },
+  basePath: '/docs',
+  reactStrictMode: true,
+  swcMinify: true
+}
+
+module.exports = nextConfig

src/fixtures/next/default.expected.mjs

@@ -0,0 +1,9 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {images: {unoptimized: true}},
+  basePath: '/docs',
+  reactStrictMode: true,
+  swcMinify: true
+}
+
+export default nextConfig

src/fixtures/next/default.js

@@ -0,0 +1,7 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+  swcMinify: true
+}
+
+module.exports = nextConfig

src/fixtures/next/default.mjs

@@ -0,0 +1,7 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+  swcMinify: true,
+}
+
+export default nextConfig

src/fixtures/nuxt.config.js

@@ -1,11 +0,0 @@
-import { resolve } from 'path'
-
-export default {
-  alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  target: 'static',
-  router: {
-    base: 'some/path'
-  }
-}

src/fixtures/nuxt.config.missing.js

@@ -1,8 +0,0 @@
-import { resolve } from 'path'
-
-export default {
-  alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  target: 'static'
-}

src/fixtures/nuxt.config.old.js

@@ -1,10 +0,0 @@
-
-module.exports={
-  alias: {
-    'style': resolve(__dirname, './assets/style')
-  },
-  target: 'static',
-  router: {
-    base: 'some/path'
-  }
-}

src/fixtures/nuxt/async.cjs

@@ -0,0 +1,15 @@
+const getAllDynamicRoute = async function() {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again'];
+  })();
+  return routes;
+};
+
+module.exports = {
+  mode: 'universal',
+  generate: {
+    async routes () {
+      return getAllDynamicRoute();
+    }
+  }
+};

src/fixtures/nuxt/async.expected.cjs

@@ -0,0 +1,17 @@
+const getAllDynamicRoute = async function() {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again'];
+  })();
+  return routes;
+};
+
+module.exports = {
+  target: 'static',
+  router: {base: '/docs/'},
+  mode: 'universal',
+  generate: {
+    async routes () {
+      return getAllDynamicRoute();
+    }
+  }
+};

src/fixtures/nuxt/async.expected.js

@@ -0,0 +1,17 @@
+const getAllDynamicRoute = async function () {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again']
+  })()
+  return routes
+}
+
+export default {
+  target: 'static',
+  router: { base: '/docs/' },
+  mode: 'universal',
+  generate: {
+    async routes() {
+      return getAllDynamicRoute()
+    }
+  }
+}

src/fixtures/nuxt/async.expected.mjs

@@ -0,0 +1,17 @@
+const getAllDynamicRoute = async function() {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again'];
+  })();
+  return routes;
+};
+
+export default {
+  target: 'static',
+  router: {base: '/docs/'},
+  mode: 'universal',
+  generate: {
+    async routes () {
+      return getAllDynamicRoute();
+    }
+  }
+};

src/fixtures/nuxt/async.js

@@ -0,0 +1,15 @@
+const getAllDynamicRoute = async function () {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again']
+  })()
+  return routes
+}
+
+export default {
+  mode: 'universal',
+  generate: {
+    async routes() {
+      return getAllDynamicRoute()
+    }
+  }
+}

src/fixtures/nuxt/async.mjs

@@ -0,0 +1,15 @@
+const getAllDynamicRoute = async function() {
+  const routes = await (async () => {
+    return ['/posts/hello-world', '/posts/hello-again'];
+  })();
+  return routes;
+};
+
+export default {
+  mode: 'universal',
+  generate: {
+    async routes () {
+      return getAllDynamicRoute();
+    }
+  }
+};

src/fixtures/nuxt/blank.expected.js

@@ -0,0 +1,2 @@
+// Default Pages configuration for Nuxt
+export default { target: 'static', router: { base: '/docs/' } }

src/fixtures/nuxt/blank.js

@@ -0,0 +1 @@
+// This file is not read by the test suite

src/fixtures/nuxt/default.cjs

@@ -0,0 +1,44 @@
+module.exports = {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [
+      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
+    ]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [
+  ],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [
+  ],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [
+  ],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [
+  ],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {
+  }
+}

src/fixtures/nuxt/default.expected.cjs

@@ -0,0 +1,46 @@
+module.exports = {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  target: 'static',
+  router: { base: "/docs/" },
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [
+      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
+    ]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [
+  ],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [
+  ],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [
+  ],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [
+  ],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {
+  }
+}

src/fixtures/nuxt/default.expected.js

@@ -0,0 +1,39 @@
+export default {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  target: 'static',
+  router: { base: '/docs/' },
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [{ rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {}
+}

src/fixtures/nuxt/default.expected.mjs

@@ -0,0 +1,46 @@
+export default {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  target: 'static',
+  router: { base: "/docs/" },
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [
+      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
+    ]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [
+  ],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [
+  ],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [
+  ],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [
+  ],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {
+  }
+}

src/fixtures/nuxt/default.js

@@ -0,0 +1,37 @@
+export default {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [{ rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {}
+}

src/fixtures/nuxt/default.mjs

@@ -0,0 +1,44 @@
+export default {
+  // Disable server-side rendering: https://go.nuxtjs.dev/ssr-mode
+  ssr: false,
+
+  // Global page headers: https://go.nuxtjs.dev/config-head
+  head: {
+    title: 'nuxt',
+    htmlAttrs: {
+      lang: 'en'
+    },
+    meta: [
+      { charset: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { hid: 'description', name: 'description', content: '' },
+      { name: 'format-detection', content: 'telephone=no' }
+    ],
+    link: [
+      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }
+    ]
+  },
+
+  // Global CSS: https://go.nuxtjs.dev/config-css
+  css: [
+  ],
+
+  // Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
+  plugins: [
+  ],
+
+  // Auto import components: https://go.nuxtjs.dev/config-components
+  components: true,
+
+  // Modules for dev and build (recommended): https://go.nuxtjs.dev/config-modules
+  buildModules: [
+  ],
+
+  // Modules: https://go.nuxtjs.dev/config-modules
+  modules: [
+  ],
+
+  // Build Configuration: https://go.nuxtjs.dev/config-build
+  build: {
+  }
+}

src/fixtures/sveltekit/blank.expected.js

@@ -0,0 +1,9 @@
+// Default Pages configuration for SvelteKit
+import adapter from '@sveltejs/adapter-auto'
+
+export default {
+  kit: {
+    paths: { base: '/docs' },
+    adapter: adapter()
+  }
+}

src/fixtures/sveltekit/blank.js

@@ -0,0 +1 @@
+// This file is not read by the test suite

src/fixtures/sveltekit/default.expected.js

@@ -0,0 +1,11 @@
+import adapter from '@sveltejs/adapter-auto'
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+  kit: {
+    paths: { base: '/docs' },
+    adapter: adapter()
+  }
+}
+
+export default config

src/fixtures/sveltekit/default.js

@@ -0,0 +1,10 @@
+import adapter from '@sveltejs/adapter-auto'
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+  kit: {
+    adapter: adapter()
+  }
+}
+
+export default config

src/get-pages-base-url.js

@@ -1,37 +0,0 @@
-const core = require('@actions/core')
-const axios = require('axios')
-const setPagesPath = require('./set-pages-path')
-
-async function getPagesBaseUrl({ repositoryNwo, githubToken, staticSiteGenerator}) {
-  try {
-    const pagesEndpoint = `https://api.github.com/repos/${repositoryNwo}/pages`
-
-    core.info(`Get the Base URL to the page with endpoint ${pagesEndpoint}`)
-    const response = await axios.get(
-      pagesEndpoint,
-      {
-        headers: {
-          Accept: 'application/vnd.github.v3+json',
-          Authorization: `Bearer ${githubToken}`
-        }
-      }
-    )
-
-    pageObject = response.data
-    core.info(JSON.stringify(pageObject))
-
-    const siteUrl = new URL(pageObject.html_url)
-    if ( staticSiteGenerator ) {
-      setPagesPath({staticSiteGenerator, path: siteUrl.pathname})
-    }
-    core.setOutput('base_url', siteUrl.href)
-    core.setOutput('origin', siteUrl.origin)
-    core.setOutput('host', siteUrl.host)
-    core.setOutput('base_path', siteUrl.pathname)
-  } catch (error) {
-    core.error('Get on the Page failed', error)
-    throw error
-  }
-}
-
-module.exports = getPagesBaseUrl

src/index.js

@@ -1,22 +1,29 @@
 const core = require('@actions/core')
 
-const enablePages = require('./enable-pages')
-const getPagesBaseUrl = require('./get-pages-base-url')
-
 // All variables we need from the runtime are loaded here
-const getContext = require('./context')
+const { getContext } = require('./context')
+
+const { findOrCreatePagesSite } = require('./api-client')
+const { setPagesPath } = require('./set-pages-path')
+const outputPagesBaseUrl = require('./output-pages-base-url')
 
 async function main() {
   try {
-    const context = getContext()
+    const { repositoryNwo, githubToken, enablement, staticSiteGenerator, generatorConfigFile } = getContext()
-    await enablePages(context)
+
-    await getPagesBaseUrl(context)
+    const pageObject = await findOrCreatePagesSite({ repositoryNwo, githubToken, enablement })
+    const siteUrl = new URL(pageObject.html_url)
+
+    if (staticSiteGenerator) {
+      setPagesPath({ staticSiteGenerator, generatorConfigFile, path: siteUrl.pathname })
+    }
+    outputPagesBaseUrl(siteUrl)
+    core.exportVariable('GITHUB_PAGES', 'true')
   } catch (error) {
     core.setFailed(error)
     process.exit(1)
   }
 }
 
-
 // Main
 main()

src/output-pages-base-url.js

@@ -0,0 +1,15 @@
+const core = require('@actions/core')
+const removeTrailingSlash = require('./remove-trailing-slash')
+
+function outputPagesBaseUrl(siteUrl) {
+  // Many static site generators do not want the trailing slash, and it is much easier to add than remove in a workflow
+  const baseUrl = removeTrailingSlash(siteUrl.href)
+  const basePath = removeTrailingSlash(siteUrl.pathname)
+
+  core.setOutput('base_url', baseUrl)
+  core.setOutput('origin', siteUrl.origin)
+  core.setOutput('host', siteUrl.host)
+  core.setOutput('base_path', basePath)
+}
+
+module.exports = outputPagesBaseUrl

src/output-pages-base-url.test.js

@@ -1,17 +1,14 @@
 const core = require('@actions/core')
-const axios = require('axios')
-//const { expect, jest } = require('@jest/globals')
 
-const getPagesBaseUrl = require('./get-pages-base-url')
+const outputPagesBaseUrl = require('./output-pages-base-url')
-
-describe('getPagesBaseUrl', () => {
-  const GITHUB_REPOSITORY = 'paper-spa/is-awesome'
-  const GITHUB_TOKEN = 'gha-token'
 
+describe('outputPagesBaseUrl', () => {
   beforeEach(() => {
     jest.restoreAllMocks()
 
-    jest.spyOn(core, 'setOutput').mockImplementation((key, value) => { key, value })
+    jest.spyOn(core, 'setOutput').mockImplementation((key, value) => {
+      key, value
+    })
     jest.spyOn(core, 'setFailed').mockImplementation(param => param)
 
     // Mock error/warning/info/debug
@@ -24,45 +21,33 @@ describe('getPagesBaseUrl', () => {
   it('gets expected outputs for profile site', async () => {
     const baseUrl = 'https://octocat.github.io/'
 
-    jest
+    outputPagesBaseUrl(new URL(baseUrl))
-      .spyOn(axios, 'get')
-      .mockImplementationOnce(() => Promise.resolve({ data: { html_url: baseUrl } }))
 
-    await getPagesBaseUrl({ repositoryNwo: GITHUB_REPOSITORY, githubToken: GITHUB_TOKEN })
+    expect(core.setOutput).toHaveBeenCalledWith('base_url', 'https://octocat.github.io')
-
-    expect(core.setOutput).toHaveBeenCalledWith('base_url', baseUrl)
     expect(core.setOutput).toHaveBeenCalledWith('origin', 'https://octocat.github.io')
     expect(core.setOutput).toHaveBeenCalledWith('host', 'octocat.github.io')
-    expect(core.setOutput).toHaveBeenCalledWith('base_path', '/')
+    expect(core.setOutput).toHaveBeenCalledWith('base_path', '')
   })
 
   it('gets expected outputs for project site', async () => {
     const baseUrl = 'https://octocat.github.io/my-repo/'
 
-    jest
+    outputPagesBaseUrl(new URL(baseUrl))
-      .spyOn(axios, 'get')
-      .mockImplementationOnce(() => Promise.resolve({ data: { html_url: baseUrl } }))
 
-    await getPagesBaseUrl({ repositoryNwo: GITHUB_REPOSITORY, githubToken: GITHUB_TOKEN })
+    expect(core.setOutput).toHaveBeenCalledWith('base_url', 'https://octocat.github.io/my-repo')
-
-    expect(core.setOutput).toHaveBeenCalledWith('base_url', baseUrl)
     expect(core.setOutput).toHaveBeenCalledWith('origin', 'https://octocat.github.io')
     expect(core.setOutput).toHaveBeenCalledWith('host', 'octocat.github.io')
-    expect(core.setOutput).toHaveBeenCalledWith('base_path', '/my-repo/')
+    expect(core.setOutput).toHaveBeenCalledWith('base_path', '/my-repo')
   })
 
   it('gets expected outputs for site with custom domain name', async () => {
     const baseUrl = 'https://www.example.com/'
 
-    jest
+    outputPagesBaseUrl(new URL(baseUrl))
-      .spyOn(axios, 'get')
-      .mockImplementationOnce(() => Promise.resolve({ data: { html_url: baseUrl } }))
 
-    await getPagesBaseUrl({ repositoryNwo: GITHUB_REPOSITORY, githubToken: GITHUB_TOKEN })
+    expect(core.setOutput).toHaveBeenCalledWith('base_url', 'https://www.example.com')
-
-    expect(core.setOutput).toHaveBeenCalledWith('base_url', baseUrl)
     expect(core.setOutput).toHaveBeenCalledWith('origin', 'https://www.example.com')
     expect(core.setOutput).toHaveBeenCalledWith('host', 'www.example.com')
-    expect(core.setOutput).toHaveBeenCalledWith('base_path', '/')
+    expect(core.setOutput).toHaveBeenCalledWith('base_path', '')
   })
 })

src/remove-trailing-slash.js

@@ -0,0 +1,3 @@
+module.exports = function removeTrailingSlash(str) {
+  return str.endsWith('/') ? str.slice(0, -1) : str
+}

src/set-pages-path.js

@@ -1,46 +1,79 @@
 const core = require('@actions/core')
-const axios = require('axios')
 const { ConfigParser } = require('./config-parser')
+const removeTrailingSlash = require('./remove-trailing-slash')
 
-async function setPagesPath({staticSiteGenerator, path}) {
+// Return the settings to be passed to a {ConfigParser} for a given static site generator,
-  try {
+// optional configuration file path, and a Pages path value to inject
-    switch(staticSiteGenerator)
+function getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, path }) {
-    {
+  switch (staticSiteGenerator) {
-      case 'nuxt':
+    case 'nuxt':
-        var ssConfig = {
+      return {
-          filePath:"./nuxt.config.js",
+        configurationFile: generatorConfigFile || './nuxt.config.js',
-          type: "nuxt",
+        blankConfigurationFile: `${__dirname}/blank-configurations/nuxt.js`,
-          pathName: "router",
+        properties: {
-          subPathName: "base",
+          // Configure a base path on the router
-          newPath: path
+          'router.base': path,
-        }
-        break;
-      case 'next':
-        var ssConfig = {
-          filePath:"./next.config.js",
-          type: "next",
-          pathName: "basePath",
-          newPath: path
-        }
-        break;
-      case 'gatsby':
-        var ssConfig = {
-          filePath: "./gatsby-config.js",
-          type: "gatsby",
-          pathName: "pathPrefix",
-          newPath: path
-        }
-        break;
-      default:
-        throw "Unknown config type"
-    }
 
-    let configParser = new ConfigParser(ssConfig)
+          // Set the target to static too
-    configParser.parse()
+          // https://nuxtjs.org/docs/configuration-glossary/configuration-target/
+          target: 'static'
+        }
+      }
+    case 'next':
+      // Next does not want a trailing slash
+      path = removeTrailingSlash(path)
 
-  } catch (error) {
+      return {
-    core.warning(`We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${path}. Please ensure your framework is configured to generate relative links appropriately.`, error)
+        configurationFile: generatorConfigFile || './next.config.js',
+        blankConfigurationFile: `${__dirname}/blank-configurations/next.js`,
+        properties: {
+          // Configure a base path
+          basePath: path,
+
+          // Disable server side image optimization too
+          // https://nextjs.org/docs/api-reference/next/image#unoptimized
+          'experimental.images.unoptimized': true
+        }
+      }
+    case 'gatsby':
+      return {
+        configurationFile: generatorConfigFile || './gatsby-config.js',
+        blankConfigurationFile: `${__dirname}/blank-configurations/gatsby.js`,
+        properties: {
+          // Configure a path prefix
+          pathPrefix: path
+        }
+      }
+    case 'sveltekit':
+      // SvelteKit does not want a trailing slash
+      path = removeTrailingSlash(path)
+
+      return {
+        configurationFile: generatorConfigFile || './svelte.config.js',
+        blankConfigurationFile: `${__dirname}/blank-configurations/sveltekit.js`,
+        properties: {
+          // Configure a base path
+          'kit.paths.base': path
+        }
+      }
+    default:
+      throw `Unsupported static site generator: ${staticSiteGenerator}`
   }
 }
 
-module.exports = setPagesPath
+// Inject Pages configuration in a given static site generator's configuration file
+function setPagesPath({ staticSiteGenerator, generatorConfigFile, path }) {
+  try {
+    // Parse the configuration file and try to inject the Pages configuration in it
+    const settings = getConfigParserSettings({ staticSiteGenerator, generatorConfigFile, path })
+    new ConfigParser(settings).injectAll()
+  } catch (error) {
+    // Logging
+    core.warning(
+      `We were unable to determine how to inject the site metadata into your config. Generated URLs may be incorrect. The base URL for this site should be ${path}. Please ensure your framework is configured to generate relative links appropriately.`,
+      error
+    )
+  }
+}
+
+module.exports = { getConfigParserSettings, setPagesPath }

src/set-pages-path.test.js

@@ -0,0 +1,105 @@
+const fs = require('fs')
+const path = require('path')
+const core = require('@actions/core')
+
+const { getConfigParserSettings } = require('./set-pages-path')
+const { ConfigParser } = require('./config-parser')
+const { getTempFolder, compareFiles } = require('./test-helpers')
+
+// Get the temp folder
+const tempFolder = getTempFolder()
+
+const SUPPORTED_GENERATORS = ['next', 'nuxt', 'gatsby', 'sveltekit']
+const SUPPORTED_FILE_EXTENSIONS = ['.js', '.cjs', '.mjs']
+
+// Test suite
+describe('configParser', () => {
+  beforeEach(() => {
+    jest.restoreAllMocks()
+
+    // Mock error/warning/info/debug to silence their output
+    jest.spyOn(core, 'error').mockImplementation(jest.fn())
+    jest.spyOn(core, 'warning').mockImplementation(jest.fn())
+    jest.spyOn(core, 'info').mockImplementation(jest.fn())
+    jest.spyOn(core, 'debug').mockImplementation(jest.fn())
+  })
+
+  // Iterate over the static site generators
+  SUPPORTED_GENERATORS.forEach(staticSiteGenerator => {
+    // Folder containing the fixtures for a given static site generator
+    const fixtureFolder = `${__dirname}/fixtures/${staticSiteGenerator}`
+
+    // Get fixture files, excluding expected results
+    const configurationFiles = fs.readdirSync(fixtureFolder).filter(filename => !filename.includes('.expected.'))
+
+    // Iterate over the fixtures, outputting to default configuration file path
+    const defaultFileExtension = '.js'
+    configurationFiles
+      .filter(filename => filename.endsWith(defaultFileExtension))
+      .forEach(configurationFile => {
+        it(`injects path properly for ${staticSiteGenerator} in ${configurationFile} to default configuration file`, async () => {
+          // Copy the source fixture to a temp file
+          const fixtureSourceFile = `${fixtureFolder}/${configurationFile}`
+          const fixtureTargetFile = `${tempFolder}/${configurationFile}`
+          if (configurationFile !== 'blank.js') {
+            fs.copyFileSync(fixtureSourceFile, fixtureTargetFile)
+          } else if (fs.existsSync(fixtureTargetFile)) {
+            fs.rmSync(fixtureTargetFile)
+          }
+
+          // Get settings for the static site generator
+          const settings = getConfigParserSettings({ staticSiteGenerator, path: '/docs/' })
+          // Update the settings
+          settings.configurationFile = fixtureTargetFile
+          // Do the injection
+          new ConfigParser(settings).injectAll()
+
+          // Read the expected file
+          const expectedFile = `${fixtureFolder}/${path.basename(
+            configurationFile,
+            defaultFileExtension
+          )}.expected${defaultFileExtension}`
+
+          // Compare the actual and expected files
+          compareFiles(settings.configurationFile, expectedFile)
+        })
+      })
+
+    SUPPORTED_FILE_EXTENSIONS.forEach(fileExtension => {
+      // Iterate over the fixtures, outputting to specified configuration file path
+      configurationFiles
+        .filter(filename => filename.endsWith(fileExtension))
+        .forEach(configurationFile => {
+          it(`injects path properly for ${staticSiteGenerator} in ${configurationFile} to specified *${fileExtension} configuration file`, async () => {
+            // Copy the source fixture to a temp file
+            const fixtureSourceFile = `${fixtureFolder}/${configurationFile}`
+            const fixtureTargetFile = `${tempFolder}/${configurationFile}`
+            if (configurationFile !== 'blank.js') {
+              fs.copyFileSync(fixtureSourceFile, fixtureTargetFile)
+            } else if (fs.existsSync(fixtureTargetFile)) {
+              fs.rmSync(fixtureTargetFile)
+            }
+
+            // Get settings for the static site generator
+            const settings = getConfigParserSettings({
+              staticSiteGenerator,
+              generatorConfigFile: fixtureTargetFile,
+              path: '/docs/'
+            })
+
+            // Do the injection
+            new ConfigParser(settings).injectAll()
+
+            // Read the expected file
+            const expectedFile = `${fixtureFolder}/${path.basename(
+              configurationFile,
+              fileExtension
+            )}.expected${fileExtension}`
+
+            // Compare the actual and expected files
+            compareFiles(settings.configurationFile, expectedFile)
+          })
+        })
+    })
+  })
+})

src/test-helpers.js

@@ -0,0 +1,39 @@
+const fs = require('fs')
+const prettier = require('prettier')
+const assert = require('assert')
+
+// Create and return the path to a temp folder
+function getTempFolder() {
+  const tmpFolder = `${__dirname}/fixtures/tmp`
+  if (!fs.existsSync(tmpFolder)) {
+    fs.mkdirSync(tmpFolder, { recursive: true })
+  }
+  return tmpFolder
+}
+
+// Read a JavaScript file and return it formatted
+function formatFile(file) {
+  const fileContent = fs.readFileSync(file, 'utf8')
+  return prettier
+    .format(fileContent, {
+      parser: 'espree',
+
+      // Prettier options
+      printWidth: 120,
+      tabWidth: 2,
+      useTabs: false,
+      semi: false,
+      singleQuote: true,
+      trailingComma: 'none',
+      bracketSpacing: true,
+      arrowParens: 'avoid'
+    })
+    .trim()
+}
+
+// Compare two JavaScript files
+function compareFiles(actualFile, expectedFile) {
+  assert.equal(formatFile(actualFile), formatFile(expectedFile))
+}
+
+module.exports = { getTempFolder, formatFile, compareFiles }