actions/ghaction-github-pages
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #200 from crazy-max/update-readme

Browse Source 
readme: set workflow permissions
This commit is contained in:
CrazyMax 2023-09-01 07:38:20 +02:00 committed by GitHub
commit 5859b4ea7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -36,6 +36,9 @@ name: website
on: push
permissions:
contents: write
jobs:
publish:
runs-on: ubuntu-latest
@ -123,7 +126,7 @@ check availability of GitHub Pages before deploying:
Following inputs can be used as `step.with` keys
| Name | Type | Description |
|----------------------|---------|--------------------------------------------------------------------------------|
|----------------------|--------|---------------------------------------------------------------------------------------------------------------------|
| `domain` | String | Git domain (default `github.com`) |
| `repo` | String | GitHub repository where assets will be deployed (default `$GITHUB_REPOSITORY`) |
| `target_branch` | String | Git branch where assets will be deployed (default `gh-pages`) |
@ -145,7 +148,7 @@ Following inputs can be used as `step.with` keys
Following environment variables can be used as `step.env` keys
| Name | Description |
|----------------|---------------------------------------|
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `GITHUB_TOKEN` | [GITHUB_TOKEN](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) as provided by `secrets` |
| `GH_PAT` | Use a [Personal Access Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) if you want to deploy to another repo |