Skip to content

Commit c0f9065

Browse files
committed
Change GITHUB_DEPLOYMENT to DOCUACTIONS_DEPLOYMENT as secret names must not start with GITHUB_.
1 parent bf5ab85 commit c0f9065

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ jobs:
1818
- uses: docuactions/github-pages@main
1919
env:
2020
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21-
GITHUB_DEPLOYMENT: ${{ secrets.GITHUB_DEPLOYMENT }}
21+
GITHUB_DEPLOYMENT: ${{ secrets.DOCUACTIONS_DEPLOYMENT }}
2222
```
2323
2424
## Configuration
2525
2626
The following settings must be passed as environment variables as shown in the example. Sensitive information, especially `GITHUB_TOKEN`, should be [set as encrypted secrets](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) — otherwise, they'll be public to anyone browsing your repository's source code and CI logs.
2727

28-
| Key | Value | Suggested Type | Required |
29-
|-------------------|-----------------------------------------------------|----------------|----------|
30-
| GITHUB_TOKEN | Github token | `secret env` | Yes |
31-
| GITHUB_DEPLOYMENT | The deployment branch (different from the main one) | `secret env` | Yes |
28+
| Key | Value | Suggested Type | Required |
29+
|------------------------|-----------------------------------------------------|----------------|----------|
30+
| GITHUB_TOKEN | Github token | `secret env` | Yes |
31+
| DOCUACTIONS_DEPLOYMENT | The deployment branch (different from the main one) | `secret env` | Yes |
3232

3333

3434
## Credits

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,5 @@ jobs:
3434
uses: peaceiris/actions-gh-pages@v3
3535
with:
3636
github_token: ${{ secrets.GITHUB_TOKEN }}
37-
publish_branch: ${{ secrets.GITHUB_DEPLOYMENT }}
37+
publish_branch: ${{ secrets.DOCUACTIONS_DEPLOYMENT }}
3838
publish_dir: ./build

0 commit comments

Comments
 (0)