{"id":18613430,"url":"https://github.com/release-it/keep-a-changelog","last_synced_at":"2025-04-05T11:13:17.479Z","repository":{"id":42044139,"uuid":"262830782","full_name":"release-it/keep-a-changelog","owner":"release-it","description":"Keep a Changelog plugin for release-it","archived":false,"fork":false,"pushed_at":"2025-01-07T09:02:34.000Z","size":47,"stargazers_count":29,"open_issues_count":0,"forks_count":15,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-29T10:09:08.660Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/release-it.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-10T16:39:20.000Z","updated_at":"2025-03-11T17:28:53.000Z","dependencies_parsed_at":"2025-02-10T00:30:30.537Z","dependency_job_id":null,"html_url":"https://github.com/release-it/keep-a-changelog","commit_stats":{"total_commits":56,"total_committers":12,"mean_commits":4.666666666666667,"dds":0.2678571428571429,"last_synced_commit":"bcbfea1ac7f06f1a5951d9039cf47408a6280297"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-it%2Fkeep-a-changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-it%2Fkeep-a-changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-it%2Fkeep-a-changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-it%2Fkeep-a-changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/release-it","download_url":"https://codeload.github.com/release-it/keep-a-changelog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247325696,"owners_count":20920714,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T03:22:04.230Z","updated_at":"2025-04-05T11:13:17.457Z","avatar_url":"https://github.com/release-it.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Keep-a-changelog plugin for release-it\n\nThis [release-it plugin](https://github.com/release-it/release-it/blob/master/docs/plugins.md) maintains your\nCHANGELOG.md file according to the [Keep A Changelog](https://keepachangelog.com/) standards.\n\nIt updates the changelog automatically by:\n\n- replacing the `## [Unreleased]` header with the current version and release date.\n- [optionally] adding a new `## [Unreleased]` header as preparation for future changes.\n\nIt does not automatically populate the changelog with commit messages from the git history!\n\nThe idea and initial implementation comes [from @eMarek](https://github.com/release-it/release-it/issues/662).\n\n```\nnpm install --save-dev @release-it/keep-a-changelog\n```\n\nIn [release-it](https://github.com/release-it/release-it) config:\n\n```json\n\"plugins\": {\n  \"@release-it/keep-a-changelog\": {\n    \"filename\": \"CHANGELOG.md\"\n  }\n}\n```\n\n## Options\n\n| option            | default value    | description                                                                                                                                      |\n| ----------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |\n| filename          | `'CHANGELOG.md'` | File with changelogs.                                                                                                                            |\n| addUnreleased     | `false`          | It leaves \"Unreleased\" title row if set to `true`.                                                                                               |\n| keepUnreleased    | `false`          | It leaves \"Unreleased\" title row unchanged if set to `true`.                                                                                     |\n| addVersionUrl     | `false`          | Links the version to the according changeset. Uses GitHub-compatible URLs by default, see other options to configure the URL format.             |\n| versionUrlFormats | See below.       | Determines the version URL format when `addVersionUrl` is set to `true`. Uses GitHub-compatible URLs by default.                                 |\n| head              | `'HEAD'`         | The git revision the new version tag is compared to in the Unreleased URL.                                                                       |\n\n### versionUrlFormats\n\nThe URL formats used when `addVersionUrl` is set to `true`. Example configuration for a repository in Azure DevOps:\n\n```json\n\"plugins\": {\n  \"@release-it/keep-a-changelog\": {\n    \"filename\": \"CHANGELOG.md\",\n    \"head\": \"main\",\n    \"addVersionUrl\": true,\n    \"versionUrlFormats\": {\n      \"repositoryUrl\": \"https://dev.azure.com/...\",\n      \"unreleasedUrl\": \"{repositoryUrl}/branchCompare?baseVersion=GT{tagName}\u0026targetVersion=GB{head}\",\n      \"versionUrl\": \"{repositoryUrl}/branchCompare?baseVersion=GT{previousTag}\u0026targetVersion=GT{tagName}\",\n      \"firstVersionUrl\": \"{repositoryUrl}?version=GT{tagName}\"\n    }\n  }\n}\n```\n\n| option          | default value                                         | description                                                                                 |\n| --------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| repositoryUrl   | `'https://{host}/{repository}'`                       | The format of the repository URL.                                                           |\n| unreleasedUrl   | `'{repositoryUrl}/compare/{tagName}...{head}'`        | The format of the `[unreleased]` section URL.                                               |\n| versionUrl      | `'{repositoryUrl}/compare/{previousTag}...{tagName}'` | The format of a release version URL.                                                        |\n| firstVersionUrl | `'{repositoryUrl}/releases/tag/{tagName}'`            | The format of the first release version URL, i.e. when no previous tags have been released. |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelease-it%2Fkeep-a-changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frelease-it%2Fkeep-a-changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelease-it%2Fkeep-a-changelog/lists"}