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

Update README.md

Browse Source
This commit is contained in:
James Ives 2019-03-03 12:25:31 -05:00 committed by GitHub
parent b586060fed
commit 3c179683fb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,8 +1,8 @@
# Github Pages Deploy Action :rocket: # GitHub Pages Deploy Action :rocket:
[![View Action](https://img.shields.io/badge/view-action-blue.svg)](https://github.com/marketplace/actions/deploy-to-github-pages) [![Issues](https://img.shields.io/github/issues/JamesIves/github-pages-deploy-action.svg)](https://github.com/JamesIves/github-pages-deploy-action/issues) [![View Action](https://img.shields.io/badge/view-action-blue.svg)](https://github.com/marketplace/actions/deploy-to-github-pages) [![Issues](https://img.shields.io/github/issues/JamesIves/github-pages-deploy-action.svg)](https://github.com/JamesIves/github-pages-deploy-action/issues)
This [Github action](https://github.com/features/actions) will handle the building and deploying process of your project to [Github Pages](https://pages.github.com/). It can be configured to upload your production ready code into any branch you'd like, including `gh-pages` and `docs`. This [GitHub action](https://github.com/features/actions) will handle the building and deploying process of your project to [GitHub Pages](https://pages.github.com/). It can be configured to upload your production ready code into any branch you'd like, including `gh-pages` and `docs`.
## Getting Started :airplane: ## Getting Started :airplane:
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 in the example below. 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 in the example below.
@ -16,17 +16,17 @@ git commit -m 'Initial gh-pages commit'
git push origin gh-pages git push origin gh-pages
``` ```
Once setup you can then include the action in your workflow to trigger on any event that [Github actions](https://github.com/features/actions) supports. Once setup you can then include the action in your workflow to trigger on any event that [GitHub actions](https://github.com/features/actions) supports.
``` ```
action "Deploy to Github Pages" { action "Deploy to GitHub Pages" {
uses = "JamesIves/github-pages-deploy-action@master" uses = "JamesIves/github-pages-deploy-action@master"
env = { env = {
BUILD_SCRIPT = "npm install && npm run-script build" BUILD_SCRIPT = "npm install && npm run-script build"
BRANCH = "gh-pages" BRANCH = "gh-pages"
FOLDER = "build" FOLDER = "build"
COMMIT_EMAIL = "github-pages-deployer@jives.dev" COMMIT_EMAIL = "github-pages-deployer@jives.dev"
COMMIT_NAME = "Github Pages Deployer" COMMIT_NAME = "GitHub Pages Deployer"
} }
secrets = ["GITHUB_TOKEN"] secrets = ["GITHUB_TOKEN"]
} }
@ -43,6 +43,6 @@ The `env` portion of the workflow **must** be configured before the action will
| `BASE_BRANCH` | The base branch of your repository which you'd like to checkout prior to deploying. This defaults to `master`. | **No** | | `BASE_BRANCH` | The base branch of your repository which you'd like to checkout prior to deploying. This defaults to `master`. | **No** |
| `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 here. | **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 here. | **Yes** |
| `COMMIT_NAME` | Used to sign the commit, this should be your name. Defaults to `gh-pages-deploy@jives.dev` | **No** | | `COMMIT_NAME` | Used to sign the commit, this should be your name. Defaults to `gh-pages-deploy@jives.dev` | **No** |
| `COMMIT_EMAIL` | Used to sign the commit, this should be your email. Defaults to `Github Pages Deployer` | **No** | | `COMMIT_EMAIL` | Used to sign the commit, this should be your email. Defaults to `GitHub Pages Deployer` | **No** |
![Example](screenshot.png) ![Example](screenshot.png)