https://github.com/devincarr/publish-gh-pages
A Github Action to publish a directory to gh-pages.
https://github.com/devincarr/publish-gh-pages
actions github-actions github-pages
Last synced: 29 days ago
JSON representation
A Github Action to publish a directory to gh-pages.
- Host: GitHub
- URL: https://github.com/devincarr/publish-gh-pages
- Owner: DevinCarr
- License: mit
- Created: 2019-01-20T00:29:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-08T04:32:12.000Z (about 6 years ago)
- Last Synced: 2025-01-17T04:12:34.956Z (over 1 year ago)
- Topics: actions, github-actions, github-pages
- Language: Shell
- Size: 2.93 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Publish to gh-pages Action
This will take a given directory (`$PUBLISH_DIRECTORY`) to publish to the `gh-pages` branch.
## Usage
You will need a [Github Personal Access Token](https://github.com/settings/tokens) with the `public_repo` permission.
```
action "Publish" {
uses = "devincarr/publish-gh-pages@master"
secrets = [
"GIT_PERSONAL_ACCESS_TOKEN",
"GIT_USER",
"GIT_EMAIL",
]
env = {
PUBLISH_DIRECTORY = "build"
}
}
```
### Secrets
- `GIT_PERSONAL_ACCESS_TOKEN`: [Github Personal Access Token](https://github.com/settings/tokens) with the `public_repo` permission.
- `GIT_USER`: Github username of the commiter.
- `GIT_EMAIL`: Github email of the commiter.
### Environment Variables
- `PUBLISH_DIRECTORY`: The action will copy all of the files from this directory into the root of the `gh-pages` branch.