Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
- [`branch-prefix`](#branch-prefix)
- [`create-pull-request`](#create-pull-request)
- [`version-rule` and `use-dev-suffix`](#version-rule-and-use-dev-suffix)
- [`token`](#token)

## `ni/python-actions/setup-python`

Expand Down Expand Up @@ -252,3 +253,14 @@ The defaults are `version-rule=patch` and `use-dev-suffix=true`, which have the

When you are ready to exit the "dev" phase, you should manually update the version number to the
desired release version before creating a release in GitHub.

#### `token`

The default GITHUB_TOKEN cannot trigger PR workflows, so the generated pull request will not run any
status checks. You can work around this by using `token` to specify a token that is saved in a
repo/org secret.

See [Triggering further workflow
runs](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs)
in the `create-pull-request` action documentation for more info about this problem and other
solutions to it.
7 changes: 7 additions & 0 deletions update-project-version/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ inputs:
Specifies whether to create a pull request. Set this to false to update
the project version without creating a pull request.
default: true
token:
description: >
GitHub token to use to create the pull request. The default GITHUB_TOKEN
cannot trigger PR workflows (i.e., it will not run PR status checks). You
can use this input to specify a PAT that is saved in a repo/org secret.
default: ${{ github.token }}
version-rule:
description: >
Specifies the rule for how to update the version number, such as "major",
Expand Down Expand Up @@ -58,6 +64,7 @@ runs:
branch: ${{ steps.set-vars.outputs.branch-name }}
commit-message: "chore: Update project version - ${{ steps.set-vars.outputs.base-branch }}"
title: "chore: Update project version - ${{ steps.set-vars.outputs.base-branch }}"
token: ${{ inputs.token }}
# The workflow log currently points to the run, not the specific job
# within that run. Linking to a specific job requires the numeric job id,
# which is not available in the github context.
Expand Down
Loading