From 30ebc9a21b4c83ef36d6286ee2323d6322871ab0 Mon Sep 17 00:00:00 2001 From: Matthew Buckett Date: Tue, 24 Jan 2023 15:44:30 +0000 Subject: [PATCH] Document that `token` now has a default. (#1) In 1.2.0 the token variable got a sensible default value so it doesn't need to be specified for the action to work. --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 11d62ece..068afd3d 100644 --- a/README.md +++ b/README.md @@ -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 | @@ -114,7 +114,6 @@ jobs: id: deployment with: step: start - token: ${{ secrets.GITHUB_TOKEN }} env: release - name: do my deploy @@ -143,7 +142,6 @@ jobs: id: deployment with: step: start - token: ${{ secrets.GITHUB_TOKEN }} env: integration - name: do my deploy @@ -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. +