{"_id":"@dialpad/semantic-release-changelog-json","_rev":"7-b4a3d22fb2578c501f01ea5b9e1559b9","name":"@dialpad/semantic-release-changelog-json","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@dialpad/semantic-release-changelog-json","version":"1.0.0","keywords":["changelog","conventional-changelog","release","semantic-release","version"],"author":{"url":"https://github.com/pvdlg","name":"Pierre Vanduynslager"},"license":"MIT","_id":"@dialpad/semantic-release-changelog-json@1.0.0","maintainers":[{"name":"jadialpad","email":"ja@dialpad.com"},{"name":"josedialpad","email":"jose.silva@dialpad.com"},{"name":"juliodialpad","email":"julio.ortega@dialpad.com"},{"name":"hynes","email":"hello@joshuahynes.com"},{"name":"dialpad-ryan","email":"ryan.lafferty@dialpad.com"},{"name":"braddialpad","email":"brad.paugh@dialpad.com"}],"homepage":"https://github.com/dialpad/semantic-release-changelog-json#readme","bugs":{"url":"https://github.com/dialpad/semantic-release-changelog-json/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":"37847a749b1ab4490ba32a7b150212139239383c","tarball":"https://registry.npmjs.org/@dialpad/semantic-release-changelog-json/-/semantic-release-changelog-json-1.0.0.tgz","fileCount":9,"integrity":"sha512-9bbDAiJR2MHI6M5KNsLQGebmg1d1exXP9O8lET6SIVWeaq6bIJrWM7WRqyohkBpq3Ad2ZPc0Rq6zCY0UC/wiVQ==","signatures":[{"sig":"MEUCIEiYVG0AqQq6BcbcbHUPMHa43WiDwS0FxG7yrwxHvvDjAiEA++jOFEZoyhujVlvwkOA8wHuYIOsJEXa2IHrjwba8NZk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10940,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvygKACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpWkg/8D+s1ABQbMjlmzngnRU+b5TtA77gdXuEJVxJZLd3F/Ko12kTQ\r\n3Sqcj0Di15HIdJjVXb7iRM5begWz8O4zDJlwEOAQLkLVmmQeBtWcNvCEM0JP\r\nnOiOyRUiLJYUCjgBs+WOpJHG8seTX10S/+Ydt7nkaSssYcpMTdwwJ8uu0kWb\r\n4IrV5EKA+AgpEKuoYE1pT4/H2jKxGMjtAPD7FE0EcWdIp8c8EaFWCrUuXUiF\r\nTv1yxZdMekZTyLRQS8oi/Nth8sowJpFNklfjsLi7WLpC2g2N+fGh4KgboHY9\r\nCuLtRwyQ9vR6MNLyX2pYowxq9MuEJF0kfVikEMdSoZRIiim6yfTrytYGACL4\r\n3i19+pn8uMBCTTn6TI6q1TK5X8CW6y1vww/iZ+lD3DxUo9XwMyEtJRnxCG84\r\n4oBG4hzCIp+NEEugUcCVC3QR5+s3AoCxDJOXw/Dxcg7WeBFOcc03I2dpiyOu\r\nHcnBOO5hGMUqhla3O6BgCIdNocvx81Ho5MTqyop6RxXjMNBrU/A/60RMhaS6\r\ns7iF0FXYEY3eSmUI7K2lJ58nkZx2SMYg7wIK9KnEn+bN8l63d14Wq9JSy491\r\n8cONtFmksKBpn1oc5yGekOfKYBgkQWBBLbiMiapFCu4GXUCP/GER4Fv5Mucf\r\nPHBw2fZoUygv3Zcl9q3KmWydueuUcvhK4Ro=\r\n=nU2q\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","engines":{"node":">=14.17"},"gitHead":"e0a9d9590a982158918610b75ff3ae43a499a567","scripts":{"lint":"xo","test":"nyc ava -v","codecov":"codecov -f coverage/coverage-final.json","pretest":"npm run lint","test:ci":"nyc ava -v","semantic-release":"semantic-release"},"_npmUser":{"name":"josedialpad","email":"jose.silva@dialpad.com"},"prettier":{"printWidth":120,"trailingComma":"es5"},"renovate":{"extends":["github>semantic-release/.github"]},"repository":{"url":"git+https://github.com/dialpad/semantic-release-changelog-json.git","type":"git"},"_npmVersion":"8.1.0","description":"semantic-release plugin to create or update a changelog file","directories":{},"_nodeVersion":"16.13.0","dependencies":{"lodash":"^4.17.4","fs-extra":"^11.0.0","aggregate-error":"^3.0.0","changelog-parser":"^3.0.1","@semantic-release/error":"^3.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"xo":"0.39.1","ava":"5.1.0","nyc":"15.1.0","sinon":"15.0.1","tempy":"1.0.1","codecov":"3.8.3","clear-module":"4.1.2","semantic-release":"20.0.2"},"peerDependencies":{"semantic-release":">=18.0.0"},"_npmOperationalInternal":{"tmp":"tmp/semantic-release-changelog-json_1.0.0_1673472009935_0.5988182388258281","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-01-11T21:20:09.848Z","modified":"2025-06-02T19:08:11.077Z","1.0.0":"2023-01-11T21:20:10.157Z"},"bugs":{"url":"https://github.com/dialpad/semantic-release-changelog-json/issues"},"author":{"url":"https://github.com/pvdlg","name":"Pierre Vanduynslager"},"license":"MIT","homepage":"https://github.com/dialpad/semantic-release-changelog-json#readme","keywords":["changelog","conventional-changelog","release","semantic-release","version"],"repository":{"url":"git+https://github.com/dialpad/semantic-release-changelog-json.git","type":"git"},"description":"semantic-release plugin to create or update a changelog file","maintainers":[],"readme":"# @semantic-release/changelog-json\n\n[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to create or update a JSON changelog file.\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 first 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","readmeFilename":"README.md"}