4.1.7

Minor Changes

• Dependency upgrades
• Modified README examples to use npm ci instead of npm install in examples by @bananer in #934
• Modified the git-config-email option again. If you wish to omit this field entirely you must now provide <> in the field instead of an empty string. This is due to the fact that GitHub Actions defaults all undefined fields to an empty string, causing the default behavior to not work when you don't provide a git-config-email parameter at all. You can find an example of this below.

name: Build and Deploy
on: [push]
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v2.3.1

      - name: Install and Build 🔧
        run: |
          npm install
          npm run build

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.6
        with:
          branch: gh-pages
          folder: build
          git-config-email: <>

New Contributors

• @bananer made their first contribution in #934

Full Changelog: 4.1.6...4.1.7

4.1.6

Minor Changes

• Resolves an issue that was causing a permission error on the cleanup job. This error was caused by other actions changing directory permissions that prevented a worktree removal step from executing correctly. #922
• Migrated the project to Node version 14 across all integration tests, nvm file, etc.
• Numerous third party dependency updates/fixes.
• The git-config-email option now accepts an empty string as a valid value in a workflow. This will allow the email part of the commit signature to empty, for example Author Name <>. You can find an example of how to utilize this below. #868

name: Build and Deploy
on: [push]
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v2.3.1

      - name: Install and Build 🔧
        run: |
          npm install
          npm run build

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.6
        with:
          branch: gh-pages
          folder: build
          git-config-email: ''

4.1.5

Minor Changes

• Resolves a bug that was causing the usage of the clean and single commit options together to fail.
• Numerous dependency and security bumps.

4.1.4

Minor Changes

• Resolves an issue with the buffer length causing issues with very large repos (thanks to @garazdawi)
• Lots of dependency updates across the board.
• Minor README adjustments.

4.1.3

Minor Changes

• Resolves a false positive error that was caused by a build cleanup step.

4.1.2

Minor Changes

• Fixed an issue that prevented you from deploying if you had a similarly named branch, ie docs and ci/docs.
• Resolved an issue that prevents you from deploying a second time in the same workflow job. The action will now correctly cleanup branch artifacts after it's done deploying.
• Standardized ESLint configuration, now using typescript-eslint as opposed to the GitHub configuration.
• Documentation change/cleanup for some parts.
• Added sponsorship automation for people who donate via GitHub Sponsors.

4.1.1

Minor Changes

• Dependency/security updates provided through Dependabot.
• Minor tooling changes, format is now lint:format for consistency.
• Removed ^ keyword in all dependencies within package.json.

4.1.0

Major Changes

• This action now supports self-hosted GitHub instances such as GitHub Enterprise. The GitHub Actions runner passes down the server url of the GitHub instance it's running on which is what the deployment step will use going forward to determine where it needs to make requests to. If you have any issues with this feature please create an issue. For more details about how to use an open source action on GitHub Enterprise please refer to the official GitHub documentation.

Minor Changes

• Dependency updates across the board.

4.0.0 🎉

🎉 Version 4 is here! Please refer to the migration guide for information on breaking changes if you were previously using version 3. 🎉

Major Changes ⚡

• All inputs should are now kebab case/lowercase as opposed to snake case.
• GITHUB_TOKEN is no longer required, if you rely on the default authentication method you can simply remove this field.
• If you rely on an ACCESS_TOKEN to make your deployments you now need to use the token input. Please refer to the migration guide for more information.
• SSH is now ssh-key and can accept either true or a private SSH key. Please refer to the README or/and migration guide for more details about how this works in this version.
• The LFS option is now deprecated.
• The PRESERVE option is no longer needed and is now deprecated.
• CLEAN_EXCLUDE has a different syntax, please refer to the README or/and migration guide for more details.
• Integration tests now run on every pull request.

Minor Changes 📜

• You can now use the dry-run input to verify compatibility in your workflow without pushing to the branch. Check out the README for additional details.
• ESlint is now enabled for unit tests.
• CodeQL is now enabled on all incoming pull requests.
• Release branch based dependencies are now automatically generated on a commit to a releases/* branch using GitHub Actions.
• Integration tests now point to version 4.
• Security documentation has been updated.
• GitHub Codespaces support has been enabled for the project.
• You no longer need to set preserve-credentials: false on the actions/checkout step. The deployment step will now appropriately discard the baked configuration before making its deployment.
• Updated logo/meta image provided by Paganini.

Special Thanks 💖

Massive thank you to @Pike for all of their contributions to version 4. This release would not have been possible if it wasn't for them.

4.0.0 Beta 03

Changelog

• Sets up native support for SSH configuration. You can also use a third party client by passing in true to the ssh-key input. For clarity the ssh input has been deprecated.
• Points integration tests to the v4 branch.
• Improves the clean exclusion experience.
• All inputs are now lowercase to match other official actions.
• Inputs are now hyphenated instead of snaked, ie CLEAN_EXCLUDE is now clean-exclude.
• Updated security documents with the new release.

For all changes please refer to the README. For further discussion please refer to the v4 thread.