{"id":15856825,"url":"https://github.com/ambiere/avae","last_synced_at":"2025-06-25T18:06:39.323Z","repository":{"id":219943649,"uuid":"750240780","full_name":"ambiere/avae","owner":"ambiere","description":"Create release notes from changelog.md file","archived":false,"fork":false,"pushed_at":"2025-06-17T01:51:37.000Z","size":820,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-17T02:40:25.259Z","etag":null,"topics":["description","release-notes"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@ambiere/avae","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/ambiere.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2024-01-30T09:04:50.000Z","updated_at":"2025-06-17T01:51:33.000Z","dependencies_parsed_at":"2024-02-20T01:28:03.814Z","dependency_job_id":"9253ba37-9ee0-4e7c-8646-0168a1eabd47","html_url":"https://github.com/ambiere/avae","commit_stats":{"total_commits":135,"total_committers":2,"mean_commits":67.5,"dds":0.4740740740740741,"last_synced_commit":"5fed92003649d0298b0ca1fc73dfa72aa78eaa83"},"previous_names":["zhid0399123/relit","zhid0399123/peni","zhid0399123/avae","ambiere/avae"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ambiere/avae","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ambiere%2Favae","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ambiere%2Favae/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ambiere%2Favae/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ambiere%2Favae/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ambiere","download_url":"https://codeload.github.com/ambiere/avae/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ambiere%2Favae/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260554226,"owners_count":23027150,"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":["description","release-notes"],"created_at":"2024-10-05T20:04:03.655Z","updated_at":"2025-06-25T18:06:38.686Z","avatar_url":"https://github.com/ambiere.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"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\u003cbr\u003e\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\u003cbr\u003e\n\n## Installation\n\nTo install `avae` into your project, run:\n\n```bash\nnpm i @ambiere/avae\n```\n\n\u003e 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\u003cpath\u003e || -r\u003cpath\u003e` \u003cbr\u003e\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\u003cpath\u003e || -o\u003cpath\u003e`\u003cbr\u003e\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\u003cnumber\u003e || -c\u003cnumber\u003e`\u003cbr\u003e\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fambiere%2Favae","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fambiere%2Favae","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fambiere%2Favae/lists"}