Skip to content

Commit

Permalink
Change: Set release action input ref per default to main
Browse files Browse the repository at this point in the history 
Just ensure that the release action gets a sane input for ref.
  • Loading branch information
@bjoernricks
bjoernricks committed Jul 11, 2023
1 parent 868ecad commit ca5d8a7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
20 changes: 10 additions & 10 deletions release/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,19 @@ You can alternatively set an explicit `release-version`. It will overwrite the `

| Argument | Description | Required? |
|----------------------|---------------------------------------------------------------------------------------------------------------------------------|-----------|
| conventional-commits | Deprecated | Optional |
| conventional-commits | Deprecated | Optional |
| git-tag-prefix | Set git tag prefix to the passed input. Default: 'v' | Optional (default is `v`) |
| github-user | Github user name on behalf of whom the actions will be executed. | Yes |
| github-user-mail | Mail address for the given github user. | Yes |
| github-user-token | Token with write rights required to create the release. | Yes |
| gpg-fingerprint | GPG fingerprint, represented as a string. Required for signing assets of the release. | Optional |
| gpg-key | GPG key, represented as a string. Required for signing assets of the release. | Optional |
| gpg-passphrase | GPG passphrase, represented as a string. Required for signing assets of the release. | Optional |
| strategy | Deprecated by `release-type`. | Optional |
| github-user | Github user name on behalf of whom the actions will be executed. | Yes |
| github-user-mail | Mail address for the given github user. | Yes |
| github-user-token | Token with write rights required to create the release. | Yes |
| gpg-fingerprint | GPG fingerprint, represented as a string. Required for signing assets of the release. | Optional |
| gpg-key | GPG key, represented as a string. Required for signing assets of the release. | Optional |
| gpg-passphrase | GPG passphrase, represented as a string. Required for signing assets of the release. | Optional |
| strategy | Deprecated by `release-type`. | Optional |
| python-version | Python version used to create the release. (Only important for python projects) | Optional (default `"3.10"` ) |
| ref | This branch's/tag's HEAD will be candidate of the next release. | Optional (default branch) |
| ref | This branch's/tag's HEAD will be candidate of the next release. | Optional (default: `main`) |
| release-type | What type of release should be executed? Supported: `alpha`, `beta`, `calendar`, `major`, `minor`, `patch`, `release-candidate` | Optional (default: `patch`) |
| release-version | Set an explicit version, that should be released. | Optional |
| release-version | Set an explicit version, that should be released. | Optional |
| release-series | Allow to determine release versions for an older release series like '22.4'. | Optional | None |
| versioning-scheme | What versioning scheme should be used for the release? Supported: `semver`, `pep440` | Optional (default: `pep440` ) |
| sign-release-files | Create and upload release file signatures. Default is 'true'. Set to an other string then 'true' to disable the signatures. | Optional (default `"true"`) |
Expand Down
6 changes: 3 additions & 3 deletions release/action.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ inputs:
description: "Python version used to create the release. (Only important for python projects)"
default: "3.10"
ref:
description: "This branch's/tag's HEAD will be candidate of the next release. Default: default branch"
default: ""
description: "This branch's/tag's HEAD will be candidate of the next release. Default: main branch"
default: "main"
release-type:
description: |
"What type of release should be executed?"
Expand Down Expand Up @@ -145,7 +145,7 @@ runs:
with:
allow: "true"
github-token: ${{ inputs.github-user-token }}
branch: ${{ inputs.ref}}
branch: ${{ inputs.ref }}

# Create release
- name: Create automatic release
Expand Down

0 comments on commit ca5d8a7

Please sign in to comment.