From 2923ce6007ad69b3b0763c08f799f512e25b2d2a Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Wed, 23 Oct 2024 16:51:48 +0200 Subject: [PATCH 01/18] Allow prepending the generated changelog to an existing one --- git-cliff-release/action.yaml | 45 +++++++++++++++++++++++++++-------- 1 file changed, 35 insertions(+), 10 deletions(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index 464e9ff..7d325cb 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -23,6 +23,11 @@ inputs: required: false type: string default: cliff.toml + existing_changelog_path: + description: Path to an existing changelog. If given, the new changelog contents will be prepended to it intelligently. + required: false + type: string + default: "" outputs: is_prerelease: description: For convenience - was the action triggered with release_type = "prerelease"? @@ -105,19 +110,39 @@ runs: GH_TOKEN: ${{ github.token }} working-directory: ${{ github.action_path }} run: | + dump_context_args=() + enhance_context_args=() + print_changelog_args=() + + if [[ -n "${{ inputs.existing_changelog_path }}" ]]; then + out_file=$GIT_CLIFF_WORKDIR/existing_changelog.md + cp "${{ inputs.existing_changelog_path }}" $out_file + + print_changelog_args+=(--prepend "$out_file") + + if [[ ${{ inputs.release_type }} = prerelease ]]; then + print_changelog_args+=(--unreleased) + else + print_changelog_args+=(--latest) + fi + else + out_file=$GIT_CLIFF_WORKDIR/new_changelog.md + print_changelog_args+=(--output "$out_file") + fi + if [[ ${{ inputs.release_type }} = prerelease ]]; then - echo 'changelog<> $GITHUB_OUTPUT - git-cliff --context | - python enhance_context.py --repo $GITHUB_REPO --unreleased-version "${{ steps.version_number.outputs.tag_name }}" | - git-cliff --from-context - >> $GITHUB_OUTPUT - echo 'EOF' >> $GITHUB_OUTPUT + enhance_context_args+=(--unreleased-version "${{ steps.version_number.outputs.tag_name }}") else - echo 'changelog<> $GITHUB_OUTPUT - git-cliff --tag "${{ steps.version_number.outputs.tag_name }}" --context | - python enhance_context.py --repo $GITHUB_REPO | - git-cliff --from-context - >> $GITHUB_OUTPUT - echo 'EOF' >> $GITHUB_OUTPUT + dump_context_args+=(--tag "${{ steps.version_number.outputs.tag_name }}") fi + + git-cliff --context | "$dump_context_args[@]" + python enhance_context.py --repo $GITHUB_REPO "$enhance_context_args[@]" | + git-cliff --from-context - "$print_changelog_args[@]" + + echo 'changelog<> $GITHUB_OUTPUT + cat $out_file >> $GITHUB_OUTPUT + echo 'EOF' >> $GITHUB_OUTPUT - name: Clean up shell: bash env: From 8c65e13268e42304f28c20efc092c1aef2fb8b3d Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Wed, 23 Oct 2024 17:09:50 +0200 Subject: [PATCH 02/18] Make token configurable --- git-cliff-release/action.yaml | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index 7d325cb..db78af0 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -28,6 +28,11 @@ inputs: required: false type: string default: "" + token: + description: Github token to be used by github CLI + required: false + type: string + default: ${{ github.token }} outputs: is_prerelease: description: For convenience - was the action triggered with release_type = "prerelease"? @@ -70,7 +75,7 @@ runs: GIT_CLIFF_REPOSITORY: ${{ github.workspace }}/__release_metadata_repo GIT_CLIFF_WORKDIR: ${{ github.action_path }} GITHUB_REPO: ${{ github.repository }} - GH_TOKEN: ${{ github.token }} + GH_TOKEN: ${{ inputs.token }} run: | if [[ '${{ inputs.release_type }}' = custom ]]; then version_number=$(echo ${{ inputs.custom_version }} | sed s/^v//) @@ -90,7 +95,7 @@ runs: GIT_CLIFF_REPOSITORY: ${{ github.workspace }}/__release_metadata_repo GIT_CLIFF_WORKDIR: ${{ github.action_path }} GITHUB_REPO: ${{ github.repository }} - GH_TOKEN: ${{ github.token }} + GH_TOKEN: ${{ inputs.token }} working-directory: ${{ github.action_path }} run: | echo 'release_notes<> $GITHUB_OUTPUT @@ -107,7 +112,7 @@ runs: GIT_CLIFF_REPOSITORY: ${{ github.workspace }}/__release_metadata_repo GIT_CLIFF_WORKDIR: ${{ github.action_path }} GITHUB_REPO: ${{ github.repository }} - GH_TOKEN: ${{ github.token }} + GH_TOKEN: ${{ inputs.token }} working-directory: ${{ github.action_path }} run: | dump_context_args=() From 221b3beca97554648055e5baaef1f2d52a8eb3ba Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Wed, 23 Oct 2024 17:14:36 +0200 Subject: [PATCH 03/18] Use different environment variable for token --- git-cliff-release/action.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index db78af0..0ed9be3 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -75,7 +75,7 @@ runs: GIT_CLIFF_REPOSITORY: ${{ github.workspace }}/__release_metadata_repo GIT_CLIFF_WORKDIR: ${{ github.action_path }} GITHUB_REPO: ${{ github.repository }} - GH_TOKEN: ${{ inputs.token }} + GITHUB_TOKEN: ${{ inputs.token }} run: | if [[ '${{ inputs.release_type }}' = custom ]]; then version_number=$(echo ${{ inputs.custom_version }} | sed s/^v//) @@ -95,7 +95,7 @@ runs: GIT_CLIFF_REPOSITORY: ${{ github.workspace }}/__release_metadata_repo GIT_CLIFF_WORKDIR: ${{ github.action_path }} GITHUB_REPO: ${{ github.repository }} - GH_TOKEN: ${{ inputs.token }} + GITHUB_TOKEN: ${{ inputs.token }} working-directory: ${{ github.action_path }} run: | echo 'release_notes<> $GITHUB_OUTPUT @@ -112,7 +112,7 @@ runs: GIT_CLIFF_REPOSITORY: ${{ github.workspace }}/__release_metadata_repo GIT_CLIFF_WORKDIR: ${{ github.action_path }} GITHUB_REPO: ${{ github.repository }} - GH_TOKEN: ${{ inputs.token }} + GITHUB_TOKEN: ${{ inputs.token }} working-directory: ${{ github.action_path }} run: | dump_context_args=() From 6ccb7b7b8a5ac1e2307e364a01f7633b246ff8b9 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Wed, 23 Oct 2024 18:02:36 +0200 Subject: [PATCH 04/18] Handle repos with no PRs --- git-cliff-release/enhance_context.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/git-cliff-release/enhance_context.py b/git-cliff-release/enhance_context.py index 2f2b92d..df978f4 100644 --- a/git-cliff-release/enhance_context.py +++ b/git-cliff-release/enhance_context.py @@ -23,6 +23,9 @@ def load_pr_issues(owner: str, repo: str) -> dict[int, list[int]]: print(f"fetch_pr_issues.sh output: {output}") raise + if pr_issues is None: + return {} + return {int(key): value for key, value in pr_issues.items()} From 62f7b8eb617928c5f9c0a4fe6b56890fc1e34672 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 09:35:33 +0200 Subject: [PATCH 05/18] I don't know bash arrays --- git-cliff-release/action.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index 0ed9be3..ea29917 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -141,9 +141,9 @@ runs: dump_context_args+=(--tag "${{ steps.version_number.outputs.tag_name }}") fi - git-cliff --context | "$dump_context_args[@]" - python enhance_context.py --repo $GITHUB_REPO "$enhance_context_args[@]" | - git-cliff --from-context - "$print_changelog_args[@]" + git-cliff --context | "${dump_context_args[@]}" + python enhance_context.py --repo $GITHUB_REPO "${enhance_context_args[@]}" | + git-cliff --from-context - "${print_changelog_args[@]}" echo 'changelog<> $GITHUB_OUTPUT cat $out_file >> $GITHUB_OUTPUT From 045a7f18ee2488b4051677dcf30df9130c9375c4 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 09:38:04 +0200 Subject: [PATCH 06/18] Syntax --- git-cliff-release/action.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index ea29917..a75f3d7 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -141,7 +141,7 @@ runs: dump_context_args+=(--tag "${{ steps.version_number.outputs.tag_name }}") fi - git-cliff --context | "${dump_context_args[@]}" + git-cliff --context "${dump_context_args[@]}" | python enhance_context.py --repo $GITHUB_REPO "${enhance_context_args[@]}" | git-cliff --from-context - "${print_changelog_args[@]}" From 734024ca9896f908a7edc430b3a74d7daf999885 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 09:48:30 +0200 Subject: [PATCH 07/18] path --- git-cliff-release/action.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index a75f3d7..56b3e0c 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -121,7 +121,7 @@ runs: if [[ -n "${{ inputs.existing_changelog_path }}" ]]; then out_file=$GIT_CLIFF_WORKDIR/existing_changelog.md - cp "${{ inputs.existing_changelog_path }}" $out_file + cp "${{ github.workspace }}/${{ inputs.existing_changelog_path }}" $out_file print_changelog_args+=(--prepend "$out_file") From b8533eccf716762a16703517ebf5fa45ac162f21 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 10:27:24 +0200 Subject: [PATCH 08/18] add comments around unreleased stuff --- git-cliff-release/action.yaml | 8 +------- git-cliff-release/cliff.toml | 6 ++++++ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index 56b3e0c..18986cf 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -123,13 +123,7 @@ runs: out_file=$GIT_CLIFF_WORKDIR/existing_changelog.md cp "${{ github.workspace }}/${{ inputs.existing_changelog_path }}" $out_file - print_changelog_args+=(--prepend "$out_file") - - if [[ ${{ inputs.release_type }} = prerelease ]]; then - print_changelog_args+=(--unreleased) - else - print_changelog_args+=(--latest) - fi + print_changelog_args+=(--prepend "$out_file" --unreleased) else out_file=$GIT_CLIFF_WORKDIR/new_changelog.md print_changelog_args+=(--output "$out_file") diff --git a/git-cliff-release/cliff.toml b/git-cliff-release/cliff.toml index 2693f0d..b67e9db 100644 --- a/git-cliff-release/cliff.toml +++ b/git-cliff-release/cliff.toml @@ -14,6 +14,9 @@ All notable changes to this project will be documented in this file.\n # template for the changelog body # https://keats.github.io/tera/docs/#introduction body = """ +{% if not version %}\ + +{% endif %}\ {% if version and extra.release_link %}\ ## [{{ version | trim_start_matches(pat="v") }}]({{ extra.release_link }}) ({{ timestamp | date(format="%Y-%m-%d") }}) {% elif extra.unreleased_version %}\ @@ -44,6 +47,9 @@ body = """ {%- endif %}\ {% endfor %} {% endfor %}\n +{% if not version %}\ + +{% endif %}\ """ # template for the changelog footer footer = """ From 241314f416b609470cbb2f4cefb4111af3d515a3 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 10:37:56 +0200 Subject: [PATCH 09/18] echo git cliff commands --- git-cliff-release/action.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index 18986cf..ff30cda 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -135,9 +135,11 @@ runs: dump_context_args+=(--tag "${{ steps.version_number.outputs.tag_name }}") fi + set -x git-cliff --context "${dump_context_args[@]}" | python enhance_context.py --repo $GITHUB_REPO "${enhance_context_args[@]}" | git-cliff --from-context - "${print_changelog_args[@]}" + set +x echo 'changelog<> $GITHUB_OUTPUT cat $out_file >> $GITHUB_OUTPUT From 18d673f2d3a4fbd72eefb90651b8f66fe5382cd3 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 12:37:25 +0200 Subject: [PATCH 10/18] less newlines --- git-cliff-release/cliff.toml | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/git-cliff-release/cliff.toml b/git-cliff-release/cliff.toml index b67e9db..5691c4c 100644 --- a/git-cliff-release/cliff.toml +++ b/git-cliff-release/cliff.toml @@ -14,9 +14,7 @@ All notable changes to this project will be documented in this file.\n # template for the changelog body # https://keats.github.io/tera/docs/#introduction body = """ -{% if not version %}\ - -{% endif %}\ +{% if not version %}{% endif %}\ {% if version and extra.release_link %}\ ## [{{ version | trim_start_matches(pat="v") }}]({{ extra.release_link }}) ({{ timestamp | date(format="%Y-%m-%d") }}) {% elif extra.unreleased_version %}\ @@ -47,9 +45,7 @@ body = """ {%- endif %}\ {% endfor %} {% endfor %}\n -{% if not version %}\ - -{% endif %}\ +{% if not version %}{% endif %}\ """ # template for the changelog footer footer = """ From 5577f50d61b5d7d0cce4dcaf4511cb73982e33b7 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 12:43:08 +0200 Subject: [PATCH 11/18] slightly more newlines --- git-cliff-release/cliff.toml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/git-cliff-release/cliff.toml b/git-cliff-release/cliff.toml index 5691c4c..0d62b3d 100644 --- a/git-cliff-release/cliff.toml +++ b/git-cliff-release/cliff.toml @@ -14,7 +14,8 @@ All notable changes to this project will be documented in this file.\n # template for the changelog body # https://keats.github.io/tera/docs/#introduction body = """ -{% if not version %}{% endif %}\ +{% if not version %} +{% endif %}\ {% if version and extra.release_link %}\ ## [{{ version | trim_start_matches(pat="v") }}]({{ extra.release_link }}) ({{ timestamp | date(format="%Y-%m-%d") }}) {% elif extra.unreleased_version %}\ @@ -45,7 +46,8 @@ body = """ {%- endif %}\ {% endfor %} {% endfor %}\n -{% if not version %}{% endif %}\ +{% if not version %} +{% endif %}\ """ # template for the changelog footer footer = """ From 5c6eb2c61d49405cd053e0db1d1595f14593e810 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 12:53:10 +0200 Subject: [PATCH 12/18] Remove unreleased stuff --- git-cliff-release/action.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index ff30cda..449fd34 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -122,6 +122,7 @@ runs: if [[ -n "${{ inputs.existing_changelog_path }}" ]]; then out_file=$GIT_CLIFF_WORKDIR/existing_changelog.md cp "${{ github.workspace }}/${{ inputs.existing_changelog_path }}" $out_file + sed '//,//d' -i $out_file print_changelog_args+=(--prepend "$out_file" --unreleased) else From 7d4cd03ad6f21dbbf72dd56aaa15c7204e88c4a9 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 13:10:26 +0200 Subject: [PATCH 13/18] Maybe this time --- git-cliff-release/action.yaml | 3 ++- git-cliff-release/cliff.toml | 2 +- git-cliff-release/enhance_context.py | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index 449fd34..0d9eb9e 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -118,15 +118,16 @@ runs: dump_context_args=() enhance_context_args=() print_changelog_args=() + out_file=$GIT_CLIFF_WORKDIR/new_changelog.md if [[ -n "${{ inputs.existing_changelog_path }}" ]]; then out_file=$GIT_CLIFF_WORKDIR/existing_changelog.md cp "${{ github.workspace }}/${{ inputs.existing_changelog_path }}" $out_file sed '//,//d' -i $out_file + dump_context_args+=(--unreleased) print_changelog_args+=(--prepend "$out_file" --unreleased) else - out_file=$GIT_CLIFF_WORKDIR/new_changelog.md print_changelog_args+=(--output "$out_file") fi diff --git a/git-cliff-release/cliff.toml b/git-cliff-release/cliff.toml index 0d62b3d..512b75c 100644 --- a/git-cliff-release/cliff.toml +++ b/git-cliff-release/cliff.toml @@ -35,7 +35,7 @@ body = """ {% else %}\ {{ commit.message | upper_first }}\ {% endif %}\ - {{" "}}([{{ commit.id | truncate(length = 7, end = "") }}]({{ commit.extra.commit_link }}))\ + {% if commit.extra.commit_link %} ([{{ commit.id | truncate(length = 7, end = "") }}]({{ commit.extra.commit_link }})){% endif %}\ {% if commit.remote.username and extra.is_release_notes %}\ {{" "}}by @{{ commit.remote.username }}\ {% elif commit.remote.username %}\ diff --git a/git-cliff-release/enhance_context.py b/git-cliff-release/enhance_context.py index df978f4..cb96ef4 100644 --- a/git-cliff-release/enhance_context.py +++ b/git-cliff-release/enhance_context.py @@ -44,7 +44,7 @@ def enhance_release( def enhance_commit(commit: dict[str, Any], pr_issues: dict[int, list[int]]) -> None: - pr_number = commit["remote"]["pr_number"] + pr_number = commit.get("remote", {}).get("pr_number") commit["extra"] = commit["extra"] or {} commit["extra"]["commit_link"] = f"{repo_url}/commit/{commit['id']}" From 7ed7cd3822758932b4ba07e225a8d44d4cf5e1cf Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 14:02:40 +0200 Subject: [PATCH 14/18] More tracing --- git-cliff-release/action.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index 0d9eb9e..a42f556 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -77,6 +77,7 @@ runs: GITHUB_REPO: ${{ github.repository }} GITHUB_TOKEN: ${{ inputs.token }} run: | + set -x if [[ '${{ inputs.release_type }}' = custom ]]; then version_number=$(echo ${{ inputs.custom_version }} | sed s/^v//) elif [[ '${{ inputs.release_type }}' = auto || '${{ inputs.release_type }}' = prerelease ]]; then @@ -98,6 +99,7 @@ runs: GITHUB_TOKEN: ${{ inputs.token }} working-directory: ${{ github.action_path }} run: | + set -x echo 'release_notes<> $GITHUB_OUTPUT git-cliff --tag "${{ steps.version_number.outputs.tag_name }}" --unreleased --context | python enhance_context.py --repo $GITHUB_REPO --release-notes | @@ -115,9 +117,11 @@ runs: GITHUB_TOKEN: ${{ inputs.token }} working-directory: ${{ github.action_path }} run: | + set -x dump_context_args=() enhance_context_args=() print_changelog_args=() + out_file=$GIT_CLIFF_WORKDIR/new_changelog.md if [[ -n "${{ inputs.existing_changelog_path }}" ]]; then @@ -137,11 +141,9 @@ runs: dump_context_args+=(--tag "${{ steps.version_number.outputs.tag_name }}") fi - set -x git-cliff --context "${dump_context_args[@]}" | python enhance_context.py --repo $GITHUB_REPO "${enhance_context_args[@]}" | git-cliff --from-context - "${print_changelog_args[@]}" - set +x echo 'changelog<> $GITHUB_OUTPUT cat $out_file >> $GITHUB_OUTPUT From 2fff6aa59ccff84c5c1ec780b61db1d7002d6494 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 14:20:05 +0200 Subject: [PATCH 15/18] Just for testing --- git-cliff-release/action.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index a42f556..9928c96 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -146,7 +146,7 @@ runs: git-cliff --from-context - "${print_changelog_args[@]}" echo 'changelog<> $GITHUB_OUTPUT - cat $out_file >> $GITHUB_OUTPUT + cat $out_file | tee -a $GITHUB_OUTPUT echo 'EOF' >> $GITHUB_OUTPUT - name: Clean up shell: bash From 685cb48c653008e72f1db47257fcedf721b9c506 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 14:53:15 +0200 Subject: [PATCH 16/18] Ensure newline --- git-cliff-release/action.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/git-cliff-release/action.yaml b/git-cliff-release/action.yaml index 9928c96..5d15d14 100644 --- a/git-cliff-release/action.yaml +++ b/git-cliff-release/action.yaml @@ -145,8 +145,10 @@ runs: python enhance_context.py --repo $GITHUB_REPO "${enhance_context_args[@]}" | git-cliff --from-context - "${print_changelog_args[@]}" + sed -i '$a\' $out_file # Make sure there is a newline at the end of the output file + echo 'changelog<> $GITHUB_OUTPUT - cat $out_file | tee -a $GITHUB_OUTPUT + cat $out_file >> $GITHUB_OUTPUT echo 'EOF' >> $GITHUB_OUTPUT - name: Clean up shell: bash From b1f91200ad05c65a0140f874f5f76314fd754300 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 15:21:33 +0200 Subject: [PATCH 17/18] Doc --- git-cliff-release/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/git-cliff-release/README.md b/git-cliff-release/README.md index 3cd3d39..0851031 100644 --- a/git-cliff-release/README.md +++ b/git-cliff-release/README.md @@ -7,6 +7,7 @@ This action uses conventional commit history to determine the recommended versio - **release_type**: One of `auto` (default), `patch`, `minor`, `major` and `custom`. `auto` means that the version will be determined based on the commit history, `custom` will use the value of the `custom_version` input parameter, and `patch`, `minor` and `major` allow forcing the bump type. - **custom_version**: Optional unless the `release_type` is set to `custom`. - **cliff_config_path**: Path to a configuration file for git-cliff. If none is given, a built-in configuration will be used. +- **existing_changelog_path**: Path to an existing changelog. If given, the new changelog contents will be prepended to it intelligently. ## Outputs From a975084844e4d170b8c1ad5d1f171bd875d9b475 Mon Sep 17 00:00:00 2001 From: Jan Buchar Date: Thu, 24 Oct 2024 15:22:29 +0200 Subject: [PATCH 18/18] Doc --- git-cliff-release/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/git-cliff-release/README.md b/git-cliff-release/README.md index 0851031..9386edb 100644 --- a/git-cliff-release/README.md +++ b/git-cliff-release/README.md @@ -8,6 +8,7 @@ This action uses conventional commit history to determine the recommended versio - **custom_version**: Optional unless the `release_type` is set to `custom`. - **cliff_config_path**: Path to a configuration file for git-cliff. If none is given, a built-in configuration will be used. - **existing_changelog_path**: Path to an existing changelog. If given, the new changelog contents will be prepended to it intelligently. +- **token**: Github token to be used by github CLI (should be relevant for private repositories only) ## Outputs