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

Fixing up the README 🚀

Browse Source
This commit is contained in:
James Ives 2019-03-03 12:10:55 -05:00 committed by GitHub
parent 81a7bf3c85
commit 36b2b7a65a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,9 +1,9 @@
# 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`.
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:
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 is what Github Pages require.
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.
```git
git checkout --orphan gh-pages
@ -14,7 +14,7 @@ git commit -m 'Initial gh-pages commit'
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.
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" {
@ -23,7 +23,7 @@ action "Deploy to Github Pages" {
BUILD_SCRIPT = "npm install && npm run-script build"
BRANCH = "gh-pages"
FOLDER = "build"
COMMIT_EMAIL = "github-pages-deployer@jamesives.dev"
COMMIT_EMAIL = "github-pages-deployer@jives.dev"
COMMIT_NAME = "Github Pages Deployer"
}
secrets = ["GITHUB_TOKEN"]
@ -32,15 +32,15 @@ action "Deploy to Github Pages" {
## Configuration 📁
The `env` portion of the workflow must be configured before the action will work. Below you'll find a description of what each one does.
The `env` portion of the workflow **must** be configured before the action will work. Below you'll find a description of what each one does.
| Key | Value Information | Required |
| ------------- | ------------- | ------------- |
| `BUILD_SCRIPT` | If you require a build script to compile your code prior to pushing it you can add the script here. The Docker container which powers the action runs Node which means `npm` commands are valid. If you're using a static site generator I'd suggest building the code prior to pushing it. | **No** |
| `BUILD_SCRIPT` | If you require a build script to compile your code prior to pushing it you can add the script here. The Docker container which powers the action runs Node which means `npm` commands are valid. If you're using a static site generator such as Jekyll I'd suggest building the code prior to pushing it to your base branch. | **No** |
| `BRANCH` | This is the branch you wish to deploy to, for example `gh-pages` or `docs`. | **Yes** |
| `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 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** |
| `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_EMAIL` | Used to sign the commit, this should be your email. Defaults to `Github Pages Deployer` | **No** |
![Example](screenshot.png)