Skip to content

Commit 5626e5f

Browse files
authored
Merge pull request #136 from buckett/token-readme
Document that `token` now has a default.
2 parents 88ce560 + 30ebc9a commit 5626e5f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The following [`inputs`](https://help.github.com/en/articles/workflow-syntax-for
6666
| Variable | Default | Purpose |
6767
| ------------ | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
6868
| `step` | | One of [`start`](#step-start), [`finish`](#step-finish), [`deactivate-env`](#step-deactivate-env), or [`delete-env`](#step-delete-env) |
69-
| `token` | | provide your `${{ secrets.GITHUB_TOKEN }}` for API access |
69+
| `token` | `${{ github.token }}` | provide your `${{ github.token }}` or `${{ secrets.GITHUB_TOKEN }}` for API access |
7070
| `env` | | identifier for environment to deploy to (e.g. `staging`, `prod`, `main`) |
7171
| `repository` | Current repository | target a specific repository for updates, e.g. `owner/repo` |
7272
| `logs` | URL to GitHub commit checks | URL of your deployment logs |
@@ -114,7 +114,6 @@ jobs:
114114
id: deployment
115115
with:
116116
step: start
117-
token: ${{ secrets.GITHUB_TOKEN }}
118117
env: release
119118
120119
- name: do my deploy
@@ -143,7 +142,6 @@ jobs:
143142
id: deployment
144143
with:
145144
step: start
146-
token: ${{ secrets.GITHUB_TOKEN }}
147145
env: integration
148146
149147
- name: do my deploy
@@ -283,4 +281,8 @@ Then you can change your workflow to target the `v1` tag, and automatically rece
283281
+ uses: bobheadxi/deployments@v1
284282
```
285283

284+
## Migrating to v1.2.0
285+
286+
The `token` configuration variable now has a default value so if you are happy with the default (`${{ github.secret }}`) you can simplify the action configuration by removing this from your actions.
287+
286288
<br />

0 commit comments

Comments
 (0)