{"repo":"orhun/git-cliff-action","free":true,"listed":false,"github":"https://github.com/orhun/git-cliff-action","clone":"git clone https://github.com/orhun/git-cliff-action.git","description":"GitHub action to generate a changelog based on the Git history","language":"Shell","stars":212,"topics":["changelog","generator","changelog-generator","github-actions-docker","github-actions","git-cliff"],"license":"Apache-2.0","category":"auth-billing-email","readme_excerpt":"git-cliff action ⛰️ This action generates a changelog based on your Git history using git-cliff on the fly! Usage Input variables - version : git-cliff version to use. (e.g. \"latest\" , \"v2.13.1\" ) - config : Path of the configuration file. (Default: \"cliff.toml\" ) - args : Arguments to pass to git-cliff. (Default: \"-v\" ) - github token : The GitHub API token used to download git-cliff and to authenticate git-cliff's GitHub integration (e.g. extracting usernames, contributors, PR links) to avoid rate limits. Requires a classic or fine-grained token without permissions. [!NOTE] GitHub API token order of precedence is as follows: 1. Input variable ( github token ) 2. Environment variable ( GITHUB TOKEN ) 3. GitHub context (default) ( ${{ github.token }} ) Output variables - changelog : Output file that contains the generated changelog. - content : Content of the changelog. - version : Version of the latest release. Environment variables - OUTPUT : Output file. (Default: \"git-cliff/CHANGELOG.md\" ) - DEBUG : Set to a not empty value (e.g. \"true\" ) to print executed commmands. (Default: unset ) [!IMPORTANT] Check out the entire history via fetch-depth: 0 before running this action. Otherwise, you might end up getting empty changelogs or git ref errors depending on arguments passed to git-cliff . Running the action outside of GitHub If you run the action in Gitea or GitHub Enterprise, the github token input is invalid. You have two options: - Pass an empty value ( github token: \"\" )","default_branch":null,"files":null,"tree":[],"storefront":"/r/orhun","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/orhun/git-cliff-action/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}