3.0.1

Minor Changes

• If the working tree is clean and there's nothing to commit, the action will now pass the build gracefully and let you know that there was nothing to commit.

3.0.0

Version 3 includes a number of breaking changes. Please refer to the migration guide at the bottom of this release for details on how to update. If you have any problems please open an issue.

Major Changes

• Completely re-written the action from a shell script into a JavaScript based action with Typescript. This will allow the action to finish its process much faster.
• Made a change so the action will no longer run a build script. This has been outlined in the migration guide and the documentation.
• The action will no longer generate a CNAME file for you automatically.
• Adjusted the order of the Git commands so the entire history is left intact.

Minor Changes

• Instead of env, the action now utilizes the with keyword in the workflow file.
• Overhauled all of the tests. There's now unit tests and integration tests.
• Improved the documentation, added details in the CONTRIBUTING file about deploying your own instance, and added GitHub badges that link to the new tests.
• Added a releases/v2 branch for legacy support.

Migration Guide

If you're coming from version 2 there's a few changes you'll need to make.

1. Adjust env to with in your workflow file.
2. Remove the BUILD_SCRIPT from your v2 workflow file, and have it run as its own step. This should look something like this:

    - name: Install
      run: |
        npm install
        npm run-script build

3. Change the reference from JamesIves/github-pages-deploy-action@releases/v2 or JamesIves/github-pages-deploy-action@master to JamesIves/github-pages-deploy-action@releases/v3. This will point your action towards the v3 and above branch.

4. Run the workflow for the first time by making a change. Once it's done manually commit any required CNAME or .nojekyll files into the deployment branch. This will only need to be done once as the Git history remains intact, so the action will not wipe out these files during future deployments.

5. Once the steps have been completed the action should deploy as expected.

Config Changes

You can find an example of a v2 config and the same v3 config below.

v2

name: integration
on: [push]
jobs:
  integration-test:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v1
    - name: Build and Deploy
      uses: JamesIves/github-pages-deploy-action@releases/v2
      env:
        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
        BRANCH: gh-pages
        FOLDER: 'test/build'
        BUILD_SCRIPT: npm install && npm run-script build

v3

name: integration
on: [push]
jobs:
  integration-test:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v1
    - name: Install
      run: |
        npm install
        npm run-script build
    - name: Build and Deploy
      uses: JamesIves/github-pages-deploy-action@releases/v3
      with:
        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
        BRANCH: gh-pages
        FOLDER: 'test/build'

2.0.3

Minor Changes

• Added the experimental ability to pass in the repositories provided GITHUB_TOKEN secret to trigger the build. There's currently an outstanding issue that prevents this from working under all conditions, you can read more about it here.

2.0.2

Major Changes

• Added an integration test that now runs everyday to ensure the action is working as intended.
• Obsoleted COMMIT_NAME and COMMIT_EMAIL variables as they are now sourced from the event payload. This ensures that the commits are properly signed in order for GitHub Pages to deploy.

Minor Changes

• Silenced the commit message as this was causing an stdout overflow bug.
• Improved the commit message so it now attaches the deployed from/to and the commit sha to the message.
• Improved the README so the example is easier to understand.

2.0.1

Minor Changes

• Made a change so the FOLDER variable cannot lead with / or ./ as it will throw an assertion error. Instead you'll now get a warning and the script will exit.
• Added an integration test that pushes on merge to master. This acts as a health check to make sure that the action is behaving as intended.

2.0.0

Going forward version 2.0.0 and above will fully support the new GitHub actions CICD/yaml workflow style. The action will still work with the former HCL style for now but it's no longer going to be actively supported as GitHub plans to deprecate it by September 30 2019.

You can learn about how to migrate your usage of this action to the new yaml format by reading the GitHub migration guide and the action README file here. The biggest change is that you now need to call the actions/checkout action prior to using this action.

Any issues can be reported here.

Major Changes

• Changes the README to use the CICD workflow instructions using the new yaml format.

1.1.3

Release Notes

• Adds -e to the script to prevent any script failures from continuing the build process.

1.1.2

Minor Changes

• Fixes an issue where the base branch would always be set to master. Thanks to @jaiselrahman for the pull request.

1.1.1

Minor Changes

• Removed unrequired files from the master branch.

1.1.0

Major Changes

• If you deploy via this action with a custom domain, Github will nuke the configuration for the domain as the CNAME file is no longer present in the gh-pages branch due to how the commits get processed. In order to solve this I've added an additional environment variable called CNAME which will add the domain record into the build directory prior to the deploy. This will maintain the GitHub configuration which will solve the issue of pages 404ing after the deploy.