Skip to content

Added information about the need to access the Deployments API in README.md #170

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

Open
dav-sea wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added information about the need to access the Deployments API in README.md #170

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
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ on:
jobs:
deploy:
runs-on: ubuntu-latest
permissions:
deployments: write
steps:
- name: start deployment
uses: bobheadxi/deployments@v1
Expand Down Expand Up @@ -63,15 +65,16 @@ Check out [this blog post](https://dev.to/bobheadxi/branch-previews-with-google-

The following [`inputs`](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepswith) configuration options are for *all steps*:

| Variable | Default | Purpose |
| ------------ | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `step` | | One of [`start`](#step-start), [`finish`](#step-finish), [`deactivate-env`](#step-deactivate-env), or [`delete-env`](#step-delete-env) |
| `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 |
| `desc` | GitHub-generated description | description for this deployment |
| `ref` | `github.ref` | Specify a particular git ref to use, (e.g. `${{ github.head_ref }}`) |
| Variable | Default | Purpose |
| ------------ | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `step` | | One of [`start`](#step-start), [`finish`](#step-finish), [`deactivate-env`](#step-deactivate-env), or [`delete-env`](#step-delete-env) |
| `token` | `${{ github.token }}` | provide your `${{ github.token }}` or `${{ secrets.GITHUB_TOKEN }}` for API access. Don't forget to make sure that the token has the rights to work with the Deployments API. Or specify `permissions.deployments: write` for your job |
| `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 |
| `desc` | GitHub-generated description | description for this deployment |
| `ref` | `github.ref` | Specify a particular git ref to use, (e.g. `${{ github.head_ref }}`) |


### `step: start`

Expand Down