Skip to content

Commit

Permalink
chore(.github/actions): add input to optionally checkout create-relea…
Browse files Browse the repository at this point in the history
…se-candidate-v1 (#135)
  • Loading branch information
Zidious authored Feb 29, 2024
1 parent e04018a commit 7a83076
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/actions/create-release-candidate-v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ A GitHub Action to create a release candidate.
| `release-script-path` | Yes | The path to the [release script](#release-script-requirements) that creates the changelogs and bumps the version of the package(s) | NA |
| `version-locked` | No | Whether or not the version bump should treat major/minor as "locked". Repos which version-lock to axe-core should default this to `true`, overriding it to `false` only for releases that update `axe-core`. | `false` |
| `docs-repo` | No | The name of the repo where the release notes live | `null` |
| `should-checkout` | No | Whether or not the action should checkout the repository. | `true` |

## Example usage

Expand Down
4 changes: 4 additions & 0 deletions .github/actions/create-release-candidate-v1/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,15 @@ inputs:
description: 'The name of the repo where the release notes live'
default: 'null'
required: false
should-checkout:
description: 'Whether or not the action should checkout the repository'
default: 'true'

runs:
using: 'composite'
steps:
- name: Checkout repository
if: ${{ inputs.should-checkout == 'true' }}
uses: actions/checkout@v4
with:
# Fetch all history
Expand Down

0 comments on commit 7a83076

Please sign in to comment.