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

Merge branch 'master' of https://github.com/JamesIves/gh-pages-github-action

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

4
Dockerfile
View File

@ -1,8 +1,8 @@
FROM node:10
LABEL "com.github.actions.name"="Deploy to Github Pages"
LABEL "com.github.actions.description"="Runs an optional build command and then pushes the branch to gh-pages."
LABEL "com.github.actions.icon"="github"
LABEL "com.github.actions.description"="This action will handle the building and deploying process of your project to Github pages."
LABEL "com.github.actions.icon"="git-commit"
LABEL "com.github.actions.color"="#192022"
LABEL "repository"="http://github.com/JamesIves/gh-pages-github-action"

10
README.md
View File

@ -1,4 +1,4 @@
# Github Pages Deploy Action :github:
# Github Pages Deploy Action :rocket:
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`.
@ -17,13 +17,13 @@ git push origin gh-pages
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" {
uses = "./action"
action "Deploy to Github Pages" {
uses = "JamesIves/github-pages-deploy-action@master"
env = {
BUILD_SCRIPT = "npm install && npm run-script build"
BRANCH = "gh-pages"
FOLDER = "build"
COMMIT_EMAIL = "iam@jamesiv.es"
COMMIT_EMAIL = "example@jives.dev"
COMMIT_NAME = "James Ives"
}
secrets = ["GITHUB_TOKEN"]
@ -40,4 +40,4 @@ The `env` portion of the workflow must be configured before the action will work
| `BRANCH` | This is the branch you wish to deploy to, for example `gh-pages` or `docs`. | **Yes** |
| `FOLDER` | The folder in your repository that you want to deploy. If your build script compiles into a directory named `build` you'd put it in here. | **Yes** |
| `COMMIT_NAME` | Used to sign the commit, this should be your name. | **No** |
| `COMMIT_EMAIL` | Used to sign the commit, this should be your email. | **No** |
| `COMMIT_EMAIL` | Used to sign the commit, this should be your email. | **No** |