{"_id":"@boxcee/changelog","_rev":"3-db2b81160286baf5ff7c4ba930f00686","name":"@boxcee/changelog","dist-tags":{"latest":"6.0.2"},"versions":{"6.0.0":{"name":"@boxcee/changelog","version":"6.0.0","keywords":["changelog","conventional-changelog","release","semantic-release","version"],"author":{"url":"https://github.com/pvdlg","name":"Pierre Vanduynslager"},"license":"MIT","_id":"@boxcee/changelog@6.0.0","maintainers":[{"name":"boxcee","email":"m.schmitzvonhuelst@gmail.com"}],"contributors":[{"url":"http://boennemann.me","name":"Stephan Bönnemann","email":"stephan@boennemann.me"},{"url":"https://twitter.com/gr2m","name":"Gregor Martynus"},{"name":"moritz Schmitz von Hülst","email":"moritz@schmitzvonhuelst.de"}],"homepage":"https://github.com/boxcee/changelog#readme","bugs":{"url":"https://github.com/boxcee/changelog/issues"},"xo":{"rules":{"unicorn/string-content":"off","unicorn/no-array-reduce":"off"},"space":true,"prettier":true},"ava":{"files":["test/**/*.test.js"]},"nyc":{"all":true,"include":["lib/**/*.js","index.js"],"reporter":["json","text","html"]},"dist":{"shasum":"9bb4a33a734d2129bedf7a9d29e3a1349fed911f","tarball":"https://registry.npmjs.org/@boxcee/changelog/-/changelog-6.0.0.tgz","fileCount":9,"integrity":"sha512-4dRSg2xehYC9bm9NGDbVAmYEtOg4dyA5WdkjNpalReSe8scxZYy86zLUT07eqa9RDsD5jgKJg+rR76tTgRbyZw==","signatures":[{"sig":"MEUCIBVA7DYEcu53nnoXhfXazYqOxzdS8CzNWVC3Jw77XYmKAiEAmoxzBV0SB80RfT6Up2zQD4jEGU/JcY3E+xKfL1vQ32M=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@boxcee%2fchangelog@6.0.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":10925},"main":"index.js","engines":{"node":">=14.17"},"gitHead":"7186fd711d7d016ae8318446e95a74906723eabd","scripts":{"lint":"xo","test":"nyc ava -v","pretest":"npm run lint","test:ci":"nyc ava -v","semantic-release":"semantic-release"},"_npmUser":{"name":"boxcee","actor":{"name":"boxcee","type":"user","email":"m.schmitzvonhuelst@gmail.com"},"email":"m.schmitzvonhuelst@gmail.com"},"prettier":{"printWidth":120,"trailingComma":"es5"},"renovate":{"extends":["github>semantic-release/.github:renovate-config"]},"repository":{"url":"git+https://github.com/boxcee/changelog.git","type":"git"},"_npmVersion":"9.8.0","description":"semantic-release plugin to create or update a changelog file","directories":{},"_nodeVersion":"22.16.0","dependencies":{"lodash":"^4.17.4","fs-extra":"^11.0.0","aggregate-error":"^3.0.0","@semantic-release/error":"^3.0.0"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"xo":"0.39.1","ava":"5.1.0","nyc":"17.0.0","sinon":"18.0.0","tempy":"1.0.1","clear-module":"4.1.2","semantic-release":"21.1.2"},"peerDependencies":{"semantic-release":">=18.0.0"},"_npmOperationalInternal":{"tmp":"tmp/changelog_6.0.0_1751355770900_0.815899528724974","host":"s3://npm-registry-packages-npm-production"}},"6.0.1":{"name":"@boxcee/changelog","version":"6.0.1","keywords":["changelog","conventional-changelog","release","semantic-release","version"],"author":{"url":"https://github.com/pvdlg","name":"Pierre Vanduynslager"},"license":"MIT","_id":"@boxcee/changelog@6.0.1","maintainers":[{"name":"boxcee","email":"m.schmitzvonhuelst@gmail.com"}],"contributors":[{"url":"http://boennemann.me","name":"Stephan Bönnemann","email":"stephan@boennemann.me"},{"url":"https://twitter.com/gr2m","name":"Gregor Martynus"},{"name":"moritz Schmitz von Hülst","email":"moritz@schmitzvonhuelst.de"}],"homepage":"https://github.com/boxcee/changelog#readme","bugs":{"url":"https://github.com/boxcee/changelog/issues"},"xo":{"rules":{"unicorn/string-content":"off","unicorn/no-array-reduce":"off"},"space":true,"prettier":true},"ava":{"files":["test/**/*.test.js"]},"nyc":{"all":true,"include":["lib/**/*.js","index.js"],"reporter":["json","text","html"]},"dist":{"shasum":"26e9fe12ddda793a228293264b59a8b6f509b84a","tarball":"https://registry.npmjs.org/@boxcee/changelog/-/changelog-6.0.1.tgz","fileCount":9,"integrity":"sha512-IPJxjkGpF6hBx9JPc1VrDCRPT0dpogQEMw+YADOIlH9GSlPliWS/fAhJa0RiJRX4+Wy4Egm/8zLujRi6jme6qw==","signatures":[{"sig":"MEQCIGtArmCg7kiGce2XOGYdBT9Z60RSb9SVz34JQigGHWtfAiAqZRQKtzDvgps/zgGCD2xrB8aFx+XLEWxJCJWpyUWNJA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@boxcee%2fchangelog@6.0.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":10922},"main":"index.js","engines":{"node":">=20"},"gitHead":"3744f390688f0b1abbb7011fcfcb3caf15ab9c75","scripts":{"lint":"xo","test":"nyc ava -v","pretest":"npm run lint","test:ci":"nyc ava -v","semantic-release":"semantic-release"},"_npmUser":{"name":"boxcee","actor":{"name":"boxcee","type":"user","email":"m.schmitzvonhuelst@gmail.com"},"email":"m.schmitzvonhuelst@gmail.com"},"prettier":{"printWidth":120,"trailingComma":"es5"},"renovate":{"extends":["github>semantic-release/.github:renovate-config"]},"repository":{"url":"git+https://github.com/boxcee/changelog.git","type":"git"},"_npmVersion":"9.8.0","description":"semantic-release plugin to create or update a changelog file","directories":{},"_nodeVersion":"22.16.0","dependencies":{"lodash":"^4.17.4","fs-extra":"^11.0.0","aggregate-error":"^3.0.0","@semantic-release/error":"^3.0.0"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"xo":"0.39.1","ava":"5.1.0","nyc":"17.0.0","sinon":"18.0.0","tempy":"1.0.1","clear-module":"4.1.2","semantic-release":"21.1.2"},"peerDependencies":{"semantic-release":">=18.0.0"},"_npmOperationalInternal":{"tmp":"tmp/changelog_6.0.1_1751356236567_0.03458200472257489","host":"s3://npm-registry-packages-npm-production"}},"6.0.2":{"name":"@boxcee/changelog","description":"semantic-release plugin to create or update a changelog file","version":"6.0.2","author":{"name":"Pierre Vanduynslager","url":"https://github.com/pvdlg"},"ava":{"files":["test/**/*.test.js"]},"bugs":{"url":"https://github.com/boxcee/changelog/issues"},"contributors":[{"name":"Stephan Bönnemann","email":"stephan@boennemann.me","url":"http://boennemann.me"},{"name":"Gregor Martynus","url":"https://twitter.com/gr2m"},{"name":"moritz Schmitz von Hülst","email":"moritz@schmitzvonhuelst.de"}],"dependencies":{"@semantic-release/error":"^3.0.0","aggregate-error":"^3.0.0","fs-extra":"^11.0.0","lodash":"^4.17.4"},"devDependencies":{"ava":"5.1.0","clear-module":"4.1.2","nyc":"17.0.0","semantic-release":"21.1.2","sinon":"18.0.0","tempy":"1.0.1","xo":"0.39.1"},"engines":{"node":">=20"},"homepage":"https://github.com/boxcee/changelog#readme","keywords":["changelog","conventional-changelog","release","semantic-release","version"],"license":"MIT","main":"index.js","nyc":{"include":["lib/**/*.js","index.js"],"reporter":["json","text","html"],"all":true},"peerDependencies":{"semantic-release":">=18.0.0"},"prettier":{"printWidth":120,"trailingComma":"es5"},"publishConfig":{"access":"public","provenance":true},"repository":{"type":"git","url":"git+https://github.com/boxcee/changelog.git"},"scripts":{"lint":"xo","pretest":"npm run lint","semantic-release":"semantic-release","test":"nyc ava -v","test:ci":"nyc ava -v"},"xo":{"prettier":true,"space":true,"rules":{"unicorn/no-array-reduce":"off","unicorn/string-content":"off"}},"renovate":{"extends":["github>semantic-release/.github:renovate-config"]},"_id":"@boxcee/changelog@6.0.2","gitHead":"fdb166cf6cecaa124526ae3f7ae122e4799c43af","_nodeVersion":"22.16.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-WXmQhv3S+nWG8HILw5Uq4/a6wQ0X4q4/fpE3ldR7uf4DKDNZ+IjcbtYNpMvEZvBQl+qZDqnX6pgtugQkiWuPyQ==","shasum":"9902ce8976fb24ba1f280db840b2369533d7e2c2","tarball":"https://registry.npmjs.org/@boxcee/changelog/-/changelog-6.0.2.tgz","fileCount":9,"unpackedSize":10922,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@boxcee%2fchangelog@6.0.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIEB7VDqVhJZFGLBrMS3bxFBL8WOtII/uDq3uehlzTPNUAiAVNa3rSZMoYxS1zSaCetuLAuUbRlxEscI3Hr6HyHeKfg=="}]},"_npmUser":{"name":"boxcee","email":"m.schmitzvonhuelst@gmail.com","actor":{"name":"boxcee","email":"m.schmitzvonhuelst@gmail.com","type":"user"}},"directories":{},"maintainers":[{"name":"boxcee","email":"m.schmitzvonhuelst@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/changelog_6.0.2_1751356388535_0.9820195468933357"},"_hasShrinkwrap":false}},"time":{"created":"2025-07-01T07:42:50.811Z","modified":"2025-07-01T07:53:09.037Z","6.0.0":"2025-07-01T07:42:51.065Z","6.0.1":"2025-07-01T07:50:36.738Z","6.0.2":"2025-07-01T07:53:08.693Z"},"bugs":{"url":"https://github.com/boxcee/changelog/issues"},"author":{"name":"Pierre Vanduynslager","url":"https://github.com/pvdlg"},"license":"MIT","homepage":"https://github.com/boxcee/changelog#readme","keywords":["changelog","conventional-changelog","release","semantic-release","version"],"repository":{"type":"git","url":"git+https://github.com/boxcee/changelog.git"},"description":"semantic-release plugin to create or update a changelog file","contributors":[{"name":"Stephan Bönnemann","email":"stephan@boennemann.me","url":"http://boennemann.me"},{"name":"Gregor Martynus","url":"https://twitter.com/gr2m"},{"name":"moritz Schmitz von Hülst","email":"moritz@schmitzvonhuelst.de"}],"maintainers":[{"name":"boxcee","email":"m.schmitzvonhuelst@gmail.com"}],"readme":"# @boxcee/changelog\n\n[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to create or update a changelog file.\n\n> [!WARNING]\n> 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/boxcee/changelog/workflows/Test/badge.svg)](https://github.com/boxcee/changelog/actions?query=workflow%3ATest+branch%3Amaster) [![npm latest version](https://img.shields.io/npm/v/@boxcee/changelog/latest.svg)](https://www.npmjs.com/package/@boxcee/changelog)\n[![npm next version](https://img.shields.io/npm/v/@boxcee/changelog/next.svg)](https://www.npmjs.com/package/@boxcee/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 @boxcee/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      \"@boxcee/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 `@boxcee/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    \"@boxcee/changelog\",\n    \"@semantic-release/npm\",\n    \"@semantic-release/git\"\n  ]\n}\n```\n","readmeFilename":"README.md"}