├── .github ├── dependabot.yml └── workflows │ └── main.yml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── action.yml ├── fixtures └── cliff.toml ├── install.sh └── run.sh /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Maintain dependencies for GitHub Actions 4 | - package-ecosystem: github-actions 5 | directory: "/" 6 | schedule: 7 | interval: daily 8 | open-pull-requests-limit: 10 9 | groups: 10 | minor: 11 | update-types: 12 | - "minor" 13 | patch: 14 | update-types: 15 | - "patch" 16 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Action Test 2 | 3 | on: [ push, pull_request ] 4 | 5 | jobs: 6 | git-cliff-action: 7 | runs-on: ubuntu-latest 8 | name: Test the git-cliff changelog generator action 9 | steps: 10 | - name: Checkout 11 | uses: actions/checkout@v4 12 | with: 13 | fetch-depth: 0 14 | - name: Generate a changelog 15 | id: git-cliff 16 | uses: ./ 17 | with: 18 | config: fixtures/cliff.toml 19 | args: --verbose --strip 'footer' --exclude-path '.github/**' --tag 0.0.0 20 | env: 21 | OUTPUT: fixtures/CHANGELOG.md 22 | - name: Print the changelog 23 | run: cat "${{ steps.git-cliff.outputs.changelog }}" 24 | - name: Print the version 25 | run: echo "${{ steps.git-cliff.outputs.version }}" 26 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2021-2024 Orhun Parmaksız 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # [git-cliff](https://github.com/orhun/git-cliff) action ⛰️ 2 | 3 | This action generates a changelog based on your Git history using [git-cliff](https://github.com/orhun/git-cliff) on the fly! 4 | 5 | ## Usage 6 | 7 | ### Input variables 8 | 9 | - `version`: `git-cliff` version to use. (e.g. `"latest"`, `"v2.7.0"`) 10 | - `config`: Path of the configuration file. (Default: `"cliff.toml"`) 11 | - `args`: [Arguments](https://github.com/orhun/git-cliff#usage) to pass to git-cliff. (Default: `"-v"`) 12 | - `github_token`: The GitHub API token used to get `git-cliff` release information via the GitHub API to avoid rate limits. (Default: `${{ github.token }}`) 13 | 14 | ### Output variables 15 | 16 | - `changelog`: Output file that contains the generated changelog. 17 | - `content`: Content of the changelog. 18 | - `version`: Version of the latest release. 19 | 20 | ### Environment variables 21 | 22 | - `OUTPUT`: Output file. (Default: `"git-cliff/CHANGELOG.md"`) 23 | 24 | > [!IMPORTANT] 25 | > Check out the entire history via `fetch-depth: 0` before running this action. 26 | > 27 | > ```yaml 28 | > - name: Checkout 29 | > uses: actions/checkout@v4 30 | > with: 31 | > fetch-depth: 0 32 | > ``` 33 | > 34 | > Otherwise, you might end up getting empty changelogs or `git ref` errors depending on arguments passed to `git-cliff`. 35 | 36 | ### Running the action outside of GitHub 37 | 38 | If you run the action in Gitea or GitHub Enterprise, the `github_token` input is invalid. You have two options: 39 | 40 | - Pass an empty value (`github_token: ""`) (limit of 60 requests per hour per IP address). 41 | - Create a GitHub token and pass it through GitHub secrets to avoid rate limiting. 42 | 43 | ### Examples 44 | 45 | #### Simple 46 | 47 | The following example fetches the whole Git history (`fetch-depth: 0`), generates a changelog in `./CHANGELOG.md`, and prints it out. 48 | 49 | ```yml 50 | jobs: 51 | changelog: 52 | name: Generate changelog 53 | runs-on: ubuntu-latest 54 | steps: 55 | - name: Checkout 56 | uses: actions/checkout@v4 57 | with: 58 | fetch-depth: 0 59 | 60 | - name: Generate a changelog 61 | uses: orhun/git-cliff-action@v4 62 | id: git-cliff 63 | with: 64 | config: cliff.toml 65 | args: --verbose 66 | env: 67 | OUTPUT: CHANGELOG.md 68 | 69 | - name: Print the changelog 70 | run: cat "${{ steps.git-cliff.outputs.changelog }}" 71 | ``` 72 | 73 | #### Advanced 74 | 75 | The following example generates a changelog for the latest pushed tag and sets it as the body of the release. 76 | 77 | It uses [svenstaro/upload-release-action](https://github.com/svenstaro/upload-release-action) for uploading the release assets. 78 | 79 | ```yml 80 | jobs: 81 | changelog: 82 | name: Generate changelog 83 | runs-on: ubuntu-latest 84 | outputs: 85 | release_body: ${{ steps.git-cliff.outputs.content }} 86 | steps: 87 | - name: Checkout 88 | uses: actions/checkout@v4 89 | with: 90 | fetch-depth: 0 91 | 92 | - name: Generate a changelog 93 | uses: orhun/git-cliff-action@v4 94 | id: git-cliff 95 | with: 96 | config: cliff.toml 97 | args: -vv --latest --strip header 98 | env: 99 | OUTPUT: CHANGES.md 100 | GITHUB_REPO: ${{ github.repository }} 101 | 102 | # use release body in the same job 103 | - name: Upload the binary releases 104 | uses: svenstaro/upload-release-action@v2 105 | with: 106 | file: binary_release.zip 107 | repo_token: ${{ secrets.GITHUB_TOKEN }} 108 | tag: ${{ github.ref }} 109 | body: ${{ steps.git-cliff.outputs.content }} 110 | 111 | # use release body in another job 112 | upload: 113 | name: Upload the release 114 | needs: changelog 115 | runs-on: ubuntu-latest 116 | steps: 117 | - name: Upload the binary releases 118 | uses: svenstaro/upload-release-action@v2 119 | with: 120 | file: binary_release.zip 121 | repo_token: ${{ secrets.GITHUB_TOKEN }} 122 | tag: ${{ github.ref }} 123 | body: ${{ needs.changelog.outputs.release_body }} 124 | ``` 125 | 126 | #### Committing the changelog 127 | 128 | You can use this action as follows if you want to generate a changelog and commit it to the repository: 129 | 130 | ```yml 131 | jobs: 132 | changelog: 133 | name: Generate changelog 134 | runs-on: ubuntu-latest 135 | permissions: 136 | contents: write 137 | steps: 138 | - name: Checkout 139 | uses: actions/checkout@v4 140 | with: 141 | fetch-depth: 0 142 | 143 | - name: Generate changelog 144 | uses: orhun/git-cliff-action@v4 145 | with: 146 | config: cliff.toml 147 | args: --verbose 148 | env: 149 | OUTPUT: CHANGELOG.md 150 | GITHUB_REPO: ${{ github.repository }} 151 | 152 | - name: Commit 153 | run: | 154 | git checkout 155 | git config user.name 'github-actions[bot]' 156 | git config user.email 'github-actions[bot]@users.noreply.github.com' 157 | set +e 158 | git add CHANGELOG.md 159 | git commit -m "Update changelog" 160 | git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git 161 | ``` 162 | 163 | Please note that you need to change the `` to the branch name that you want to push. 164 | 165 | ## License 166 | 167 | Licensed under either of [Apache License Version 2.0](./LICENSE-APACHE) or [The MIT License](./LICENSE-MIT) at your option. 168 | 169 | ## Copyright 170 | 171 | Copyright © 2021-2024, [Orhun Parmaksız](mailto:orhunparmaksiz@gmail.com) 172 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: "git-cliff - Changelog Generator" 2 | description: "Generate changelog based on your Git history" 3 | inputs: 4 | version: 5 | description: "git-cliff version" 6 | required: false 7 | default: "v2.7.0" 8 | config: 9 | description: "config file location" 10 | required: false 11 | default: "cliff.toml" 12 | args: 13 | description: "git-cliff arguments" 14 | required: false 15 | default: "-v" 16 | github_token: 17 | description: "GitHub API token" 18 | required: false 19 | default: "${{ github.token }}" 20 | outputs: 21 | changelog: 22 | description: "output file" 23 | value: ${{ steps.run-git-cliff.outputs.changelog }} 24 | content: 25 | description: "content of the changelog" 26 | value: ${{ steps.run-git-cliff.outputs.content }} 27 | version: 28 | description: "version of the latest release" 29 | value: ${{ steps.run-git-cliff.outputs.version }} 30 | runs: 31 | using: "composite" 32 | steps: 33 | - name: Download git-cliff 34 | shell: bash 35 | run: ${GITHUB_ACTION_PATH}/install.sh 36 | env: 37 | RUNNER_OS: ${{ runner.os }} 38 | RUNNER_ARCH: ${{ runner.arch }} 39 | VERSION: ${{ inputs.version }} 40 | GITHUB_API_TOKEN: ${{ inputs.github_token }} 41 | 42 | - name: Run git-cliff 43 | id: run-git-cliff 44 | shell: bash 45 | run: ${GITHUB_ACTION_PATH}/run.sh --config=${{ inputs.config }} ${{ inputs.args }} 46 | 47 | branding: 48 | icon: "triangle" 49 | color: "green" 50 | -------------------------------------------------------------------------------- /fixtures/cliff.toml: -------------------------------------------------------------------------------- 1 | # configuration file for git-cliff 2 | 3 | [changelog] 4 | header = "# Changelog\n" 5 | body = """ 6 | {% if version %}\ 7 | ## [{{ version | replace(from="v", to="") }}] - {{ timestamp | date(format="%Y-%m-%d") }} 8 | {% else %}\ 9 | ## [unreleased] 10 | {% endif %}\ 11 | {% for group, commits in commits | group_by(attribute="group") %} 12 | ### {{ group | upper_first }} 13 | {% for group, commits in commits | group_by(attribute="scope") %}\ 14 | #### {{ group }}\ 15 | {% for commit in commits %} 16 | - {{ commit.message | upper_first }}\ 17 | {% endfor %} 18 | {% endfor %}\ 19 | {% endfor %}\n 20 | """ 21 | trim = true 22 | footer = "\n" 23 | 24 | [git] 25 | conventional_commits = true 26 | -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | if [[ -n "$DEBUG" ]]; then 4 | set -x 5 | fi 6 | 7 | set -euo pipefail 8 | 9 | ARCHIVE_EXT='tar.gz' 10 | ARCHIVE_CMD='tar -xf' 11 | GIT_CLIFF_BIN='git-cliff' 12 | 13 | case "${RUNNER_OS}" in 14 | macOS) 15 | OS=apple-darwin 16 | ;; 17 | Windows) 18 | OS=pc-windows-msvc 19 | ARCHIVE_EXT='zip' 20 | ARCHIVE_CMD='7z x -aoa' 21 | GIT_CLIFF_BIN="${GIT_CLIFF_BIN}.exe" 22 | ;; 23 | *) 24 | OS=unknown-linux-gnu 25 | ;; 26 | esac 27 | case "${RUNNER_ARCH}" in 28 | ARM64) ARCH=aarch64 ;; 29 | ARM) ARCH=pc-windows-msvc ;; 30 | X86) ARCH=i686 ;; 31 | *) ARCH=x86_64 ;; 32 | esac 33 | 34 | INSTALL_DIR="$RUNNER_TEMP/git-cliff" 35 | mkdir -p "$INSTALL_DIR" 36 | cd "$INSTALL_DIR" 37 | 38 | echo "git-cliff-${ARCH}-${OS}.${ARCHIVE_EXT}" 39 | 40 | RELEASE_URL='https://api.github.com/repos/orhun/git-cliff/releases/latest' 41 | if [[ "${VERSION}" != 'latest' ]]; then 42 | RELEASE_URL="https://api.github.com/repos/orhun/git-cliff/releases/tags/${VERSION}" 43 | fi 44 | echo "Getting git-cliff ${VERSION} from ${RELEASE_URL}" 45 | 46 | # Caching is disabled in order not to receive stale responses from Varnish cache fronting GitHub API. 47 | if [[ -z "${GITHUB_API_TOKEN}" ]]; then 48 | RELEASE_INFO="$(curl --silent --show-error --fail \ 49 | --header 'Cache-Control: no-cache, must-revalidate' \ 50 | "${RELEASE_URL}")" 51 | else 52 | # Although releases endpoint is available without authentication, the current github.token is still passed 53 | # in order to increase the limit of 60 requests per hour per IP address to a higher value that's also counted 54 | # per GitHub account. 55 | RELEASE_INFO="$(curl --silent --show-error --fail \ 56 | --header "authorization: Bearer ${GITHUB_API_TOKEN}" \ 57 | --header 'Cache-Control: no-cache, must-revalidate' \ 58 | "${RELEASE_URL}")" 59 | fi 60 | 61 | TAG_NAME="$(echo "${RELEASE_INFO}" | jq --raw-output ".tag_name")" 62 | TARGET="git-cliff-${TAG_NAME:1}-${ARCH}-${OS}.${ARCHIVE_EXT}" 63 | LOCATION="$(echo "${RELEASE_INFO}" | 64 | jq --raw-output ".assets[].browser_download_url" | 65 | grep "${TARGET}$")" 66 | echo "Found release: ${LOCATION}" 67 | 68 | # Create bin directory 69 | mkdir -p ./bin 70 | 71 | # Skip downloading release if downloaded already, e.g. when the action is used multiple times. 72 | if [[ ! -e "$TARGET" ]]; then 73 | echo "Downloading ${TARGET}..." 74 | curl --silent --show-error --fail --location --output "$TARGET" "$LOCATION" 75 | echo "Unpacking ${TARGET}..." 76 | ${ARCHIVE_CMD} "$TARGET" 77 | mv git-cliff-${TAG_NAME:1}/${GIT_CLIFF_BIN} "./bin/$GIT_CLIFF_BIN" 78 | else 79 | echo "Using cached git-cliff binary." 80 | fi 81 | 82 | echo "git-cliff is ready to use!" 83 | -------------------------------------------------------------------------------- /run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -uxo pipefail 4 | 5 | # Avoid file expansion when passing parameters like with '*' 6 | set -o noglob 7 | 8 | GIT_CLIFF_BIN='git-cliff' 9 | 10 | if [[ "${RUNNER_OS}" == 'Windows' ]]; then 11 | GIT_CLIFF_BIN="${GIT_CLIFF_BIN}.exe" 12 | fi 13 | 14 | GIT_CLIFF_PATH="$RUNNER_TEMP/git-cliff/bin/$GIT_CLIFF_BIN" 15 | 16 | # Set up working directory 17 | owner=$(stat -c "%u:%g" .) 18 | chown -R "$(id -u)" . 19 | 20 | # Create the output directory 21 | OUTPUT=${OUTPUT:="git-cliff/CHANGELOG.md"} 22 | mkdir -p "$(dirname $OUTPUT)" 23 | 24 | # Separate arguments before passing them to git-cliff command 25 | args=$(echo "$@" | xargs) 26 | 27 | # Execute git-cliff 28 | GIT_CLIFF_OUTPUT="$OUTPUT" "$GIT_CLIFF_PATH" $args 29 | exit_code=$? 30 | 31 | # Retrieve context 32 | CONTEXT="$(mktemp)" 33 | GIT_CLIFF_OUTPUT="$CONTEXT" "$GIT_CLIFF_PATH" --context $args 34 | 35 | # Revert permissions 36 | chown -R "$owner" . 37 | 38 | # Set the changelog content (max: 50MB) 39 | FILESIZE=$(stat -c%s "$OUTPUT") 40 | MAXSIZE=$((40 * 1024 * 1024)) 41 | if [ "$FILESIZE" -le "$MAXSIZE" ]; then 42 | echo "content<>$GITHUB_OUTPUT 43 | cat "$OUTPUT" >>$GITHUB_OUTPUT 44 | echo "EOF" >>$GITHUB_OUTPUT 45 | cat "$OUTPUT" 46 | fi 47 | 48 | # Set output file 49 | echo "changelog=$OUTPUT" >>$GITHUB_OUTPUT 50 | 51 | # Set the version output to the version of the latest release 52 | echo "version=$(jq -r '.[0].version' $CONTEXT)" >>$GITHUB_OUTPUT 53 | 54 | # Pass exit code to the next step 55 | echo "exit_code=$exit_code" >>$GITHUB_OUTPUT 56 | --------------------------------------------------------------------------------