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.

4.0.0 Beta 02

Changelog

• dry-run capabilities: #505
• Remove the need for the GITHUB_TOKEN input variable: #525
• CodeQL Adjustments: #540
• PR based integration tests: #505
• Automate deployment task: #541

For further discussion please refer to the v4 thread.

4.0.0 Beta 01

Changelog

• LFS and PRESERVE are now obsoleted, and the action no longer checks out a base branch. This will prevent some issues when the workflow files
• Adds linting files to test files.

For further discussion please refer to the v4 thread.

3.7.1

Major Changes

• You can now use absolute folder paths in your workflow. These can be used using the ~ syntax, for example: ~/a/folder/based/on/root. For most use cases placing just the folder name in this parameter will still be sufficient.

• Adds an initial check to ensure that the folder you're trying to deploy exists before it gets further down in the workflow. If it doesn't exist the action will exit with a helpful error message. Due some structural differences related to this change you should now only call run if you're using this as a node module in your own action. Running the individual deploy methods are now error prone and the direct use of them will eventually be deprecated. The README has been updated to reflect this.

Minor Changes

• The action is now built using Node 12.
• Adds additional type for users running as a node module called NodeActionInterface, this allows you to see the required parameters without all of the additional runtime data for GitHub Actions.
• Upgrades numerous dependencies and added a dependabot.yml file.
• Re-structured some of the unit tests so they now properly mock error returns.
• Added rimraf so Windows users can run the build script.
• Fixed numerous eslint issues presented by eslint-plugin-github.
• Changed the links in the startup job as some of them are now out of date.

Community

Special thanks to @subhashissuara @koooge @pheeel and @exuanbo for their contributions to this update. If you have any questions please reach out on our new GitHub Discussions board.

Sponsors

If you'd like to sponsor the maintenance of this project you can do so via GitHub Sponsors!

3.6.2

Major Changes

• Adds a new option called PRESERVE which allows any changes made before the deployment step to be stashed/applied right before the commits are made. This allows you to make changes to files which are tracked as part of Git prior to running the deployment step. Please refer to the README for more information about this option. This option is still experimental, please create an issue if you encounter any problems. In a later release this option will likely be toggled on by default.

Minor Changes

• Fixed an issue that caused git remote rm origin from failing workflows when origin doesn't exist. The action will now tolerate the error and move onto the next step.
• Dependency updates.
• Minor README adjustments.

Community

I was recently interviewed by GitHub about this action! You can read all about it here.

3.6.1

Minor Changes

• Aligns version numbers on the registry.

3.6.0

Major Changes

• The CLEAN option is now toggled on by default. If you wish to turn it off you must set CLEAN: false in your workflow configuration. This change was made as it confused a lot of people and it seemed to be the expected behavior from most users anyway.
• Added an option to migrate all files from Git LFS so they can be committed to the deployment branch. To turn this on you can set LFS: true in your workflow configuration.

Minor Changes

• Plenty of dependency updates from Dependabot.

3.5.9

Minor Changes

• Added the --no-verify flag to the commit commands to prevent pre-commit hooks form interfering with the action commands.

3.5.8

Minor Changes

• Made a change that prevents the CLEAN option from ignoring .nojekyll and CNAME files. It will now selectivly ignore these files only if they don't exist in the deployment folder. This allows you to update and upload them if you're using this option while still preventing mismatches from nuking them in the deployment branch. The README has also been updated to let you know that you need to manually delete them from the deployment branch should the need arise.
• Made a small adjustment to the icons in the init function.
• Added a note about dependency versions and Dependabot in the README. Also made the base example use a tagged version as this is more consistent than referencing the releases/v3 branch directly.
• Dependency updates for ESLint/Node Types etc.