Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document that token now has a default. #136

Merged
merged 1 commit into from
Feb 25, 2023
Merged

Document that token now has a default. #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The following [`inputs`](https://help.github.com/en/articles/workflow-syntax-for
| Variable | Default | Purpose |
| ------------ | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `step` | | One of [`start`](#step-start), [`finish`](#step-finish), [`deactivate-env`](#step-deactivate-env), or [`delete-env`](#step-delete-env) |
| `token` | | provide your `${{ secrets.GITHUB_TOKEN }}` for API access |
| `token` | `${{ github.token }}` | provide your `${{ github.token }}` or `${{ secrets.GITHUB_TOKEN }}` for API access |
| `env` | | identifier for environment to deploy to (e.g. `staging`, `prod`, `main`) |
| `repository` | Current repository | target a specific repository for updates, e.g. `owner/repo` |
| `logs` | URL to GitHub commit checks | URL of your deployment logs |
Expand Down Expand Up @@ -114,7 +114,6 @@ jobs:
id: deployment
with:
step: start
token: ${{ secrets.GITHUB_TOKEN }}
env: release

- name: do my deploy
Expand Down Expand Up @@ -143,7 +142,6 @@ jobs:
id: deployment
with:
step: start
token: ${{ secrets.GITHUB_TOKEN }}
env: integration

- name: do my deploy
Expand Down Expand Up @@ -283,4 +281,8 @@ Then you can change your workflow to target the `v1` tag, and automatically rece
+ uses: bobheadxi/deployments@v1
```

## Migrating to v1.2.0

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.

<br />