adk23333/github-pages-deploy-action
1
0
Fork 0
mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Couple of fixes

Browse Source
This commit is contained in:
James Ives 2019-03-03 09:46:26 -05:00
parent 420901d6f8
commit a03e6cae67
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -3,14 +3,18 @@
This Github action will handle the building and deploying process of your project to Github pages. It can be configured to upload your production ready code into any branch you'd like, including `gh-pages` and `docs`.
## Getting Started :airplane:
Before you get started you must first create a fresh branch where the action will deploy the files to.
Before you get started you must first create a fresh branch where the action will deploy the files to. You can replace `gh-pages` with whatever branch you'd like to use below. This will create a new orphaned branch which the deployer action can then push files to.
```git
git checkout --orphan gh-pages
git push origin
git rm -rf .
touch README.md
git add README.md
git commit -m 'Initial gh-pages commit'
git push origin gh-pages
```
Once setup you can then include the script in your workflow to trigger on any built in event that Github supports.
Once setup you can then include the action in your workflow to trigger on any built in event that Github supports.
```
action "Deploy to gh-pages" {

0
entrypoint.sh Normal file → Executable file
View File