🚀 Automatically deploy your project to GitHub Pages using GitHub Actions. This action can be configured to push your production-ready code into any branch you'd like.
npm ci
instead of npm install
in examples by @bananer in https://github.com/JamesIves/github-pages-deploy-action/pull/934
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/[email protected]
- name: Install and Build 🔧
run: |
npm install
npm run build
- name: Deploy 🚀
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: build
git-config-email: <>
Full Changelog: https://github.com/JamesIves/github-pages-deploy-action/compare/4.1.6...4.1.7
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. #868name: Build and Deploy
on: [push]
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/[email protected]
- name: Install and Build 🔧
run: |
npm install
npm run build
- name: Deploy 🚀
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: build
git-config-email: ''
docs
and ci/docs
.🎉 Version 4 is here! Please refer to the migration guide for information on breaking changes if you were previously using version 3. 🎉
GITHUB_TOKEN
is no longer required, if you rely on the default authentication method you can simply remove this field.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.LFS
option is now deprecated.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.dry-run
input to verify compatibility in your workflow without pushing to the branch. Check out the README for additional details.releases/*
branch using GitHub Actions.preserve-credentials: false
on the actions/checkout
step. The deployment step will now appropriately discard the baked configuration before making its deployment.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.
true
to the ssh-key
input. For clarity the ssh
input has been deprecated.CLEAN_EXCLUDE
is now clean-exclude
.For all changes please refer to the README. For further discussion please refer to the v4 thread.