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

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"

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"]