{"id":13816590,"url":"https://github.com/antfu/changelogithub","last_synced_at":"2025-05-14T04:10:09.383Z","repository":{"id":37390050,"uuid":"502811084","full_name":"antfu/changelogithub","owner":"antfu","description":"Generate changelog for GitHub","archived":false,"fork":false,"pushed_at":"2025-03-01T06:03:14.000Z","size":467,"stargazers_count":808,"open_issues_count":10,"forks_count":41,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-11T05:03:26.694Z","etag":null,"topics":["changelog","github","github-actions","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/antfu.png","metadata":{"funding":{"github":["antfu"],"open_collective":"antfu"},"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-06-13T04:58:57.000Z","updated_at":"2025-05-08T08:17:15.000Z","dependencies_parsed_at":"2024-02-09T02:11:06.906Z","dependency_job_id":"eea98a66-a89c-4901-83eb-2081b0175837","html_url":"https://github.com/antfu/changelogithub","commit_stats":{"total_commits":190,"total_committers":17,"mean_commits":"11.176470588235293","dds":"0.20526315789473681","last_synced_commit":"a8105df48ea57c1ed3868661b2a656b6cc54b222"},"previous_names":[],"tags_count":71,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antfu%2Fchangelogithub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antfu%2Fchangelogithub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antfu%2Fchangelogithub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antfu%2Fchangelogithub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/antfu","download_url":"https://codeload.github.com/antfu/changelogithub/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254070109,"owners_count":22009559,"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","github-actions","release"],"created_at":"2024-08-04T05:00:46.650Z","updated_at":"2025-05-14T04:10:04.307Z","avatar_url":"https://github.com/antfu.png","language":"TypeScript","readme":"# changelogithub\n\n[![NPM version](https://img.shields.io/npm/v/changelogithub?color=a1b858\u0026label=)](https://www.npmjs.com/package/changelogithub)\n\nGenerate changelog for GitHub releases from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), powered by [changelogen](https://github.com/unjs/changelogen).\n\n[👉 Changelog example](https://github.com/unocss/unocss/releases/tag/v0.39.0)\n\n## Features\n\n- Support exclamation mark as breaking change, e.g. `chore!: drop node v10`\n- Grouped scope in changelog\n- Create the release note, or update the existing one\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@v4\n        with:\n          fetch-depth: 0\n\n      - name: Set node\n        uses: actions/setup-node@v4\n        with:\n          registry-url: https://registry.npmjs.org/\n          node-version: lts/*\n\n      - run: npx changelogithub # or changelogithub@0.12 to ensure a stable result\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 `changelogithub.config.{json,ts,js,mjs,cjs}`, `.changelogithubrc` or use the `changelogithub` field in `package.json`.\n\n## Preview Locally\n\n```bash\nnpx changelogithub --dry\n```\n\n## Why?\n\nI used to use [`conventional-github-releaser`](https://github.com/conventional-changelog/releaser-tools/tree/master/packages/conventional-github-releaser) for almost all my projects. Until I found that it [does NOT support using exclamation marks for breaking changes](https://github.com/conventional-changelog/conventional-changelog/issues/648) - hiding those important breaking changes in the changelog without the awareness from maintainers.\n\n## License\n\n[MIT](./LICENSE) License © 2022 [Anthony Fu](https://github.com/antfu)\n","funding_links":["https://github.com/sponsors/antfu","https://opencollective.com/antfu"],"categories":["TypeScript","GitHub Actions","github-actions"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantfu%2Fchangelogithub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantfu%2Fchangelogithub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantfu%2Fchangelogithub/lists"}