{"_id":"@ambiere/avae","_rev":"3-fdd0fbccce10e7b615a803da9db5e41a","name":"@ambiere/avae","dist-tags":{"latest":"0.1.3"},"versions":{"0.1.0":{"name":"@ambiere/avae","version":"0.1.0","description":"Create release notes from changelog.md file","main":"index.js","bin":{"avae":"src/bin.js"},"scripts":{"lint":"standard --verbose","lint:fix":"standard --fix","test":"tap test/**/*.test.js --allow-incomplete-coverage","version":"cz bump","avae":"avae --count 1","post:version":"conventional-changelog -p conventionalCommits -i CHANGELOG.md -s -r 2 && git add CHANGELOG.md","prepare":"node .husky/install.js"},"engines":{"node":">=18"},"keywords":["releases","notes","changelog","tags"],"author":{"name":"zhid0399123","email":"zhid0399123@gmail.com"},"license":"MIT","dependencies":{"avae":"^0.0.0","commist":"^3.2.0","help-me":"^5.0.0","split2":"^4.2.0","yargs-parser":"^21.1.1"},"repository":{"type":"git","url":"git+https://github.com/zhid0399123/avae.git"},"bugs":{"url":"https://github.com/zhid0399123/avae/issues"},"homepage":"https://github.com/zhid0399123/avae#readme","devDependencies":{"husky":"^9.0.7","lint-staged":"^15.2.0","tap":"^18.7.0"},"_id":"@ambiere/avae@0.1.0","gitHead":"58c9a6213838ddbe1d8e80c14d72ac543603121a","_nodeVersion":"21.6.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-qWUp9VTOjlFWvL2LPrtAqWmM9T+E2ezIGNWNxQcHQdgRp7wA+J0gD5UEbjZkjpxvVcGny7dLNa1BEjp3Zo9Mdg==","shasum":"d302204584c07e517f04abecc55eab9ba4f01123","tarball":"https://registry.npmjs.org/@ambiere/avae/-/avae-0.1.0.tgz","fileCount":21,"unpackedSize":20468,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCID7Num0CiLAoCNyTmCfY2bULqaFbDDmgYzh8DepnUcl4AiBb6zLidOtZvUGZyat2oP7sngbirCzT9BZwAdNZj1GNHA=="}]},"_npmUser":{"name":"ambiere","email":"itsambiere@gmail.com"},"directories":{},"maintainers":[{"name":"ambiere","email":"itsambiere@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/avae_0.1.0_1707996607371_0.23813995286849354"},"_hasShrinkwrap":false},"0.1.1":{"name":"@ambiere/avae","version":"0.1.1","description":"Create release notes from changelog.md file","main":"index.js","bin":{"avae":"src/bin.js"},"scripts":{"lint":"standard --verbose","lint:fix":"standard --fix","test":"tap test/**/*.test.js --allow-incomplete-coverage","avae":"avae --count 1","prepare":"node .husky/install.js"},"engines":{"node":">=18"},"keywords":["releases","notes","changelog","tags"],"author":{"name":"ambiere","email":"itsambiere@gmail.com"},"license":"MIT","dependencies":{"@ambiere/avae":"^0.1.0","commist":"^3.2.0","help-me":"^5.0.0","split2":"^4.2.0","yargs-parser":"^21.1.1"},"repository":{"type":"git","url":"git+https://github.com/ambiere/avae.git"},"bugs":{"url":"https://github.com/ambiere/avae/issues"},"homepage":"https://github.com/ambiere/avae#readme","devDependencies":{"husky":"^9.0.7","lint-staged":"^15.2.0","tap":"^18.7.0"},"_id":"@ambiere/avae@0.1.1","gitHead":"ad11ed7a9b20e102c98d13d0d527239a1296c900","_nodeVersion":"21.6.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-aY0hDhikYPaUrOnCphrT9pA1mW1Ps0XQV/WDtOVbDkjhNmsMwkVWmFZ3EtbybnARhinJrtJIKDo7dCVII9tw9Q==","shasum":"11d48abfe04f419ea178b2b6e1b179a6b7c5f8bd","tarball":"https://registry.npmjs.org/@ambiere/avae/-/avae-0.1.1.tgz","fileCount":22,"unpackedSize":27042,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDs5zVP2gH0wkC5EI9knTPNvSUSkZpK+ukxSCxEPGYd/gIhAOfU0RjW5Gz+xefhzp+09GrfYchArfRDeDrTwOV8hfag"}]},"_npmUser":{"name":"ambiere","email":"itsambiere@gmail.com"},"directories":{},"maintainers":[{"name":"ambiere","email":"itsambiere@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/avae_0.1.1_1707998398474_0.651432844277037"},"_hasShrinkwrap":false},"0.1.2":{"name":"@ambiere/avae","version":"0.1.2","description":"Create release notes from changelog.md file","main":"index.js","bin":{"avae":"src/bin.js"},"scripts":{"lint":"standard --verbose","lint:fix":"standard --fix","test":"tap test/**/*.test.js --allow-incomplete-coverage","avae":"avae --count 1","prepare":"node .husky/install.js"},"engines":{"node":">=18"},"keywords":["releases","notes","changelog","tags"],"author":{"name":"ambiere","email":"itsambiere@gmail.com"},"license":"MIT","dependencies":{"@ambiere/avae":"^0.1.1","commist":"^3.2.0","help-me":"^5.0.0","split2":"^4.2.0","yargs-parser":"^21.1.1"},"repository":{"type":"git","url":"git+https://github.com/ambiere/avae.git"},"bugs":{"url":"https://github.com/ambiere/avae/issues"},"homepage":"https://github.com/ambiere/avae#readme","devDependencies":{"husky":"^9.0.7","lint-staged":"^15.2.0","tap":"^18.7.0"},"_id":"@ambiere/avae@0.1.2","gitHead":"bfe0b7dac8d89b1063a3aed8ec41caecc2e99749","_nodeVersion":"21.6.2","_npmVersion":"10.2.4","dist":{"integrity":"sha512-0Clax1nu6iwvc0gstnNH3wcUxXG9UfuFRrLvx2a3fxBOTSMUTYPcNDH2mQe9cRgMJQyr4y1nZ/WpxBuJEEdJpg==","shasum":"d5090e5ed5303a594abbd992c8726a953a56fb92","tarball":"https://registry.npmjs.org/@ambiere/avae/-/avae-0.1.2.tgz","fileCount":21,"unpackedSize":26620,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDeoGNbij1pFeNw2q7rqFfVmnacKh0kAC9I9sMM3rCGbAIgRJ31qI5qgwHH9OgMDHhKCpucYqPDNqAqB1bs0/qjcTs="}]},"_npmUser":{"name":"ambiere","email":"itsambiere@gmail.com"},"directories":{},"maintainers":[{"name":"ambiere","email":"itsambiere@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/avae_0.1.2_1707999442319_0.5168569859269692"},"_hasShrinkwrap":false},"0.1.3":{"name":"@ambiere/avae","version":"0.1.3","description":"Create release notes from changelog.md file","main":"index.js","bin":{"avae":"src/bin.js"},"scripts":{"lint":"standard --verbose","lint:fix":"standard --fix","test":"tap test/**/*.test.js --allow-incomplete-coverage","avae":"avae --count 1","prepare":"node .husky/install.js"},"engines":{"node":">=18"},"keywords":["releases","notes","changelog","tags"],"author":{"name":"ambiere","email":"itsambiere@gmail.com"},"license":"MIT","dependencies":{"@ambiere/avae":"^0.1.1","commist":"^3.2.0","help-me":"^5.0.0","split2":"^4.2.0","yargs-parser":"^21.1.1"},"repository":{"type":"git","url":"git+https://github.com/ambiere/avae.git"},"bugs":{"url":"https://github.com/ambiere/avae/issues"},"homepage":"https://github.com/ambiere/avae#readme","devDependencies":{"@types/node":"^20.11.25","husky":"^9.0.7","lint-staged":"^15.2.0","tap":"^18.7.0"},"_id":"@ambiere/avae@0.1.3","gitHead":"37cc8c6ddffbd234bd65f964f669eeb5286983b4","_nodeVersion":"21.6.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-Cuyhuu4+MX+ZWenKff9e9umRooRbaTdA57/v/eCVr7Uh3aqkbVo5K4fMPSe0QNnylt8Ojrt3bRPxaG+vFC9EfQ==","shasum":"98f293e45d3f39fe5d684a3efaa1dc1462168188","tarball":"https://registry.npmjs.org/@ambiere/avae/-/avae-0.1.3.tgz","fileCount":7,"unpackedSize":10452,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIC6leDJew3FJ6kjv+keMIqHBVro3tTOYFZpGbnTmkn1nAiBEB3PU2ks0HSv6xu+OWc/DMFoNvSbQklED12y8l+mwOQ=="}]},"_npmUser":{"name":"ambiere","email":"itsambiere@gmail.com"},"directories":{},"maintainers":[{"name":"ambiere","email":"itsambiere@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/avae_0.1.3_1710005728980_0.47166305158776867"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-15T11:30:07.183Z","0.1.0":"2024-02-15T11:30:07.535Z","modified":"2024-03-09T17:35:29.961Z","0.1.1":"2024-02-15T11:59:58.654Z","0.1.2":"2024-02-15T12:17:22.512Z","0.1.3":"2024-03-09T17:35:29.120Z"},"maintainers":[{"name":"ambiere","email":"itsambiere@gmail.com"}],"description":"Create release notes from changelog.md file","homepage":"https://github.com/ambiere/avae#readme","keywords":["releases","notes","changelog","tags"],"repository":{"type":"git","url":"git+https://github.com/ambiere/avae.git"},"author":{"name":"ambiere","email":"itsambiere@gmail.com"},"bugs":{"url":"https://github.com/ambiere/avae/issues"},"license":"MIT","readme":"# avae\n\nStreamline the generation of release notes/text from your changelog file effortlessly. Whether you're managing a large-scale project or a smaller development effort, `avae` empowers you to create professional and comprehensive release notes/text with ease.\n\n`avae` read the changelog file from top to bottom and create release file from it. `avae` relies on version tags in the changelog as the parsing boundary. The version tags should follow sermantic versioning (`vX.Y.Z`).\n
\n\n[![Test](https://github.com/ambiere/avae/actions/workflows/continue-integration.yml/badge.svg)](https://github.com/ambiere/avae/actions/workflows/continue-integration.yml)\n[![Publish](https://github.com/ambiere/avae/actions/workflows/continue-deployment.yml/badge.svg)](https://github.com/ambiere/avae/actions/workflows/continue-deployment.yml)\n
\n\n## Installation\n\nTo install `avae` into your project, run:\n\n```bash\nnpm i @ambiere/avae\n```\n\n> NOTE: avae is also available as a command line interface which enables you to generate release notes effortlessly from the terminal. To install avae cli run:\n\n```bash\nnpm i -g @ambiere/avae\n```\n\nFor available commands, run:\n\n```bash\navae help\n```\n\n## Example\n\nTo use it in your npm project, configure `avae` in your package.json file by running the following command:\n\n```bash\nnpm pkg set scripts.avae=avae\n```\n\nTo generate release text later on, run:\n\n```bash\nnpm run avae\n\n```\n\nAbove command will read `CHANGELOG.md` and generate `RELEASE.md` file in the root directory of the project. By default, the file to read from is `CHANGELOG.md` and output file to write to is `RELEASE.md`\n\nOptionally, you can import avae into your javascript file and create release text by calling `createReleasetText` function.\n\n```js\nimport * as createReleasetText from \"avae\"\n\nconst read = path.join(__dirname, \"CHANGELOG.md\")\nconst out = path.join(__dirname, \"RELEASE.md\")\n\ncreateReleasetText(read, out, 1)\n```\n\nterminal logs:\n\n```bash\n\n[RELEASE]: writing RELEASE.md\n[RELEASE]: saved RELEASE.md\n+ RELEASE.md ++++++++++++++++++++++++++++++++\n```\n\n## Options\n\nTo customize the default behaviour of avae, you can pass several options when runing avae.\n\n1: `--read || -r`
\nSpecify the dir/filename path from which avae should read from. Example:\n\n```bash\nnpm run avae --read \"CHANGELOG.md\"\n```\n\n2: `--out || -o`
\nSpecify the dir/filename path to which avae should output/write. Example:\n\n```bash\nnpm run avae --out \"RELEASE.md\"\n```\n\n3: `--count || -c`
\nSpecify the number of releases that should be written to the output file. Example:\n\n```bash\nnpm run avae --count 1\n```\n\n## CI/CD\n\nFor automation purposes, avae can be used together with `softprops/action-gh-release` to generate release notes on tags push.\nBelow is the workflow example that impliment `avae` and `softprops/action-gh-release` to generate release notes.\n\n```yaml\nname: Release\non:\n push:\n tags:\n - \"v*.*.*\"\npermissions:\n contents: read\n\njobs:\n releae:\n permissions:\n contents: write # for softprops/action-gh-release to create GitHub release\n runs-on: ubuntu-latest\n environment: release\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n - name: Install Node.js\n uses: actions/setup-node@v4\n with:\n node-version: 21\n name: Install dependencies\n run: npm ci\n - name: Publish Packages\n env:\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n run: |\n npm config set \"//registry.npmjs.org/:_authToken\" \"${NPM_TOKEN}\" # pnpm config set is broken\n pnpm release\n - name: Generate release description\n run: pnpm run avae\n - name: Release\n uses: softprops/action-gh-release@v1\n with:\n draft: true\n files: dist/*\n body_path: RELEASE.md\n\n\n```\n\n## TODO\n\nTailor release notes to meet your project's specific requirements using customizable templates and formatting options.\n\n## Contributing\n\nPlease refer to the [Contributing Guidelines](https://github.com/ambiere/avae/blob/main/CONTRIBUTING.md).\n\n## license\n\nLicensed under the **[MIT License](https://github.com/ambiere/avae/blob/main/LICENSE)**.\n","readmeFilename":"README.md"}