From ca5d8a7fbe5f6722454364f8f3e7ee1314109768 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Ricks?= Date: Tue, 11 Jul 2023 11:30:43 +0200 Subject: [PATCH] Change: Set release action input `ref` per default to `main` Just ensure that the release action gets a sane input for ref. --- release/README.md | 20 ++++++++++---------- release/action.yaml | 6 +++--- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/release/README.md b/release/README.md index 6570679b..c5be3070 100644 --- a/release/README.md +++ b/release/README.md @@ -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"`) | diff --git a/release/action.yaml b/release/action.yaml index e73a1bf2..b9a8f93a 100644 --- a/release/action.yaml +++ b/release/action.yaml @@ -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?" @@ -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