{"id":22435319,"url":"https://github.com/aneoconsulting/order-github-release-notes","last_synced_at":"2026-02-26T06:34:30.560Z","repository":{"id":161450850,"uuid":"636151912","full_name":"aneoconsulting/order-github-release-notes","owner":"aneoconsulting","description":"Organize auto generated changelog using the GitHub API","archived":false,"fork":false,"pushed_at":"2024-12-11T16:59:06.000Z","size":117,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-27T08:24:31.789Z","etag":null,"topics":["changelog","github","notes","release"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/aneoconsulting.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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}},"created_at":"2023-05-04T08:27:36.000Z","updated_at":"2024-12-11T16:58:37.000Z","dependencies_parsed_at":"2024-03-28T00:21:33.763Z","dependency_job_id":null,"html_url":"https://github.com/aneoconsulting/order-github-release-notes","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aneoconsulting%2Forder-github-release-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aneoconsulting%2Forder-github-release-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aneoconsulting%2Forder-github-release-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aneoconsulting%2Forder-github-release-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aneoconsulting","download_url":"https://codeload.github.com/aneoconsulting/order-github-release-notes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248755481,"owners_count":21156602,"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","github","notes","release"],"created_at":"2024-12-05T23:13:09.683Z","updated_at":"2025-10-30T23:32:33.475Z","avatar_url":"https://github.com/aneoconsulting.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# order-github-release-notes\n\n[![NPM version](https://img.shields.io/npm/v/@aneoconsultingfr/order-github-release-notes?color=fe5001\u0026label=)](https://www.npmjs.com/package/@aneoconsultingfr/order-github-release-notes)\n\nOrganize auto generated changelog using the GitHub API in order to allow merge commit (instead of squash).\nUse [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), powered by [changelogen](https://github.com/unjs/changelogen).\n\nWe use\n\n## Features\n\n- Organize auto generated changelog using the GitHub API\n- Allow merge commit\n- List contributors\n\n## Usage\n\nIn GitHub Actions:\n\n```yml\n# .github/workflows/release.yml\n\nname: Release\n\npermissions:\n  contents: write\n\non:\n  push:\n    tags:\n      - 'v*'\n\njobs:\n  release:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n        with:\n          fetch-depth: 0\n\n      - uses: actions/setup-node@v3\n        with:\n          node-version: 16.x\n\n      - run: npx @aneoconsultingfr/order-github-release-notes\n        env:\n          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}\n```\n\nIt will be trigged whenever you push a tag to GitHub that starts with `v`.\n\n## Configuration\n\nYou can put a configuration file in the project root, named as `order-github-release-notes.config.{json,ts,js,mjs,cjs}`, `.order-github-release-notesrc` or use the `order-github-release-notes` field in `package.json`.\n\n## Preview Locally\n\n```bash\nexport GITHUB_TOKEN=$(gh auth token)\n```\n\n```bash\nnpx @aneoconsultingfr/order-github-release-notes --dry\n```\n\nIn order to avoid to use a GitHub token, you can use the `--input` flag to provide data.\n\n```bash\nnpx @aneoconsultingfr/order-github-release-notes --input '* feat: a new feature\n* fix: a bug fix\n* docs: documentation only changes\n* @new-contributor: a new contributor\n'\n```\n\n## Dev\n\n```bash\nnci -D\n```\n\n## License\n\n[MIT](./LICENSE) License © 2023 [Aneo](https://github.com/aneoconsulting)\n\n## Credits\n\nHeavily inspired by [changelogithub](https://github.com/antfu/changelogithub) from [Anthony Fu](https://github.com/antfu)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faneoconsulting%2Forder-github-release-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faneoconsulting%2Forder-github-release-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faneoconsulting%2Forder-github-release-notes/lists"}