{"id":13850849,"url":"https://github.com/semantic-release/changelog","last_synced_at":"2025-05-15T20:03:59.078Z","repository":{"id":37445092,"uuid":"114206579","full_name":"semantic-release/changelog","owner":"semantic-release","description":":blue_book: semantic-release plugin to create or update a changelog file","archived":false,"fork":false,"pushed_at":"2025-05-02T16:14:01.000Z","size":2373,"stargazers_count":318,"open_issues_count":42,"forks_count":29,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-04T08:02:59.861Z","etag":null,"topics":["changelog","conventional-changelog","release","semantic-release","version"],"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/semantic-release.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,"zenodo":null}},"created_at":"2017-12-14T05:29:44.000Z","updated_at":"2025-05-01T12:36:37.000Z","dependencies_parsed_at":"2023-02-19T04:46:13.433Z","dependency_job_id":"defd0fff-7bea-425b-9901-4fdcb5d93459","html_url":"https://github.com/semantic-release/changelog","commit_stats":{"total_commits":297,"total_committers":11,"mean_commits":27.0,"dds":0.2828282828282829,"last_synced_commit":"11d763f70d126b2fda165dc16a1c94e6151e3349"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semantic-release%2Fchangelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semantic-release%2Fchangelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semantic-release%2Fchangelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/semantic-release%2Fchangelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/semantic-release","download_url":"https://codeload.github.com/semantic-release/changelog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252542252,"owners_count":21764934,"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":["changelog","conventional-changelog","release","semantic-release","version"],"created_at":"2024-08-04T21:00:26.791Z","updated_at":"2025-05-15T20:03:58.110Z","avatar_url":"https://github.com/semantic-release.png","language":"JavaScript","funding_links":[],"categories":["About","JavaScript","others"],"sub_categories":[],"readme":"# @semantic-release/changelog\n\n[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to create or update a changelog file.\n\n\u003e [!WARNING]\n\u003e Please consider whether committing release notes to a file is worth the [added complexity](https://semantic-release.gitbook.io/semantic-release/support/faq#should-release-notes-be-committed-to-a-changelog.md-in-my-repository-during-a-release) compared to other available options for capturing release notes.\n\n[![Build Status](https://github.com/semantic-release/changelog/workflows/Test/badge.svg)](https://github.com/semantic-release/changelog/actions?query=workflow%3ATest+branch%3Amaster) [![npm latest version](https://img.shields.io/npm/v/@semantic-release/changelog/latest.svg)](https://www.npmjs.com/package/@semantic-release/changelog)\n[![npm next version](https://img.shields.io/npm/v/@semantic-release/changelog/next.svg)](https://www.npmjs.com/package/@semantic-release/changelog)\n\n| Step               | Description                                                                                                                                                                                           |\n| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `verifyConditions` | Verify the `changelogFile` and `changelogTitle` options configuration.                                                                                                                                |\n| `prepare`          | Create or update a changelog file in the local project directory with the changelog content created in the [generate notes step](https://github.com/semantic-release/semantic-release#release-steps). |\n\n## Install\n\n```bash\n$ npm install @semantic-release/changelog -D\n```\n\n## Usage\n\nThe plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):\n\n```json\n{\n  \"plugins\": [\n    \"@semantic-release/commit-analyzer\",\n    \"@semantic-release/release-notes-generator\",\n    [\n      \"@semantic-release/changelog\",\n      {\n        \"changelogFile\": \"docs/CHANGELOG.md\"\n      }\n    ],\n    [\n      \"@semantic-release/git\",\n      {\n        \"assets\": [\"docs/CHANGELOG.md\"]\n      }\n    ]\n  ]\n}\n```\n\nWith this example, for each release, a `docs/CHANGELOG.md` will be created or updated.\n\n## Configuration\n\n### Options\n\n| Options          | Description                                           | Default        |\n| ---------------- | ----------------------------------------------------- | -------------- |\n| `changelogFile`  | File path of the changelog.                           | `CHANGELOG.md` |\n| `changelogTitle` | Title of the changelog file (first line of the file). | -              |\n\n### Examples\n\nWhen used with the [@semantic-release/git](https://github.com/semantic-release/git) or [@semantic-release/npm](https://github.com/semantic-release/npm) plugins the `@semantic-release/changelog` plugin must be called before those plugins in order to update the changelog file so the [@semantic-release/git](https://github.com/semantic-release/git) and [@semantic-release/npm](https://github.com/semantic-release/npm) plugins can include it in the release.\n\n```json\n{\n  \"plugins\": [\n    \"@semantic-release/commit-analyzer\",\n    \"@semantic-release/release-notes-generator\",\n    \"@semantic-release/changelog\",\n    \"@semantic-release/npm\",\n    \"@semantic-release/git\"\n  ]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsemantic-release%2Fchangelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsemantic-release%2Fchangelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsemantic-release%2Fchangelog/lists"}