status-im
/
actions-gh-pages
mirror of https://github.com/status-im/actions-gh-pages.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: ✏️ add explanation for User and Organization Pages sites 

Closes: #15
This commit is contained in:
peaceiris 2019-09-08 11:32:27 +09:00
parent 568c603f29
commit 844594e15d
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -36,6 +36,8 @@ Next, Go to **Repository Settings**
### (2) Create `.github/workflows/gh-pages.yml`
#### Repository type - Project
An example yaml file with Hugo action.
- [peaceiris/actions-hugo: GitHub Actions for Hugo extended](https://github.com/peaceiris/actions-hugo)
@ -70,6 +72,25 @@ jobs:
PUBLISH_DIR: ./public
```
The above example is for [Project Pages sites]. (`<username>/<project_name>` repository)
#### Repository type - User and Organization
For [User and Organization Pages sites] (`<username>/<username>.github.io` repository),
we have to set `master` branch to `PUBLISH_BRANCH`.
```yaml
on:
push:
branches:
- source # default branch
PUBLISH_BRANCH: master # deploying branch
```
[Project Pages sites]: https://help.github.com/en/articles/user-organization-and-project-pages#project-pages-sites
[User and Organization Pages sites]: https://help.github.com/en/articles/user-organization-and-project-pages#user-and-organization-pages-sites
### Options
#### Pull action image from Docker Hub
@ -93,7 +114,7 @@ By pulling docker images, you can reduce the overall execution time of your work
#### `PERSONAL_TOKEN`
[Create a personal access token (`repo`)](https://github.com/settings/tokens) and add it to Secrets as `PERSONAL_TOKEN`, it works as well as `ACTIONS_DEPLOY_KEY`.
[Generate a personal access token (`repo`)](https://github.com/settings/tokens) and add it to Secrets as `PERSONAL_TOKEN`, it works as well as `ACTIONS_DEPLOY_KEY`.
```diff
- ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}