{"id":22096517,"url":"https://github.com/uphold/github-changelog-generator","last_synced_at":"2025-10-18T05:10:09.025Z","repository":{"id":18797235,"uuid":"74680677","full_name":"uphold/github-changelog-generator","owner":"uphold","description":"Generate changelog files from the project's GitHub PRs","archived":false,"fork":false,"pushed_at":"2025-03-21T17:20:13.000Z","size":450,"stargazers_count":13,"open_issues_count":11,"forks_count":1,"subscribers_count":62,"default_branch":"master","last_synced_at":"2025-07-11T02:58:32.428Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"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/uphold.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2016-11-24T14:32:40.000Z","updated_at":"2025-06-06T15:17:41.000Z","dependencies_parsed_at":"2023-11-03T14:35:54.629Z","dependency_job_id":null,"html_url":"https://github.com/uphold/github-changelog-generator","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/uphold/github-changelog-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fgithub-changelog-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fgithub-changelog-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fgithub-changelog-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fgithub-changelog-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uphold","download_url":"https://codeload.github.com/uphold/github-changelog-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fgithub-changelog-generator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266913680,"owners_count":24005579,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-12-01T04:11:25.815Z","updated_at":"2025-10-18T05:10:03.998Z","avatar_url":"https://github.com/uphold.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# github-changelog-generator\n\nGenerate changelog files from the project's GitHub PRs.\n\n## Usage\n\nGenerate a new [GitHub Personal Access Token](https://github.com/settings/tokens) and save it to your `.zshrc.local`, `.bashrc.local` or similar:\n\n```sh\nexport GITHUB_TOKEN=\u003cyour_github_personal_access_token\u003e\n```\n\nTo see a list of available options, run the following command:\n\n```sh\n$ github-changelog-generator --help\n\n  Usage: github-changelog-generator [options]\n\n  Run GitHub changelog generator.\n\n  Options:\n\n    -h,   --help                       output usage information\n    -b,   --base-branch \u003cname\u003e         [optional] specify the base branch name - master by default\n    -f,   --future-release \u003cversion\u003e   [optional] specify the next release version\n    -t,   --future-release-tag \u003cname\u003e  [optional] specify the next release tag name if it is different from the release version\n    -rtp, --release-tag-prefix         [optional] release tag prefix to consider when finding the latest release, useful for monorepos\n    -cfp, --changed-files-prefix       [optional] changed files prefix to consider when finding pull-requests, useful for monorepos\n    -l,   --labels \u003cnames\u003e             [optional] labels to filter pull requests by\n    -o,   --owner \u003cname\u003e               [optional] owner of the repository\n    -r,   --repo \u003cname\u003e                [optional] name of the repository\n    --rebuild                          rebuild the full changelog\n```\n\nTo generate a changelog for your GitHub project, use the following command:\n\n```sh\n$ echo \"$(github-changelog-generator --base-branch=\u003cbase\u003e --future-release=\u003crelease_name\u003e --future-release-tag=\u003crelease_tag_name\u003e --owner=\u003crepo_owner\u003e --repo=\u003crepo_name\u003e)\\n$(tail -n +2 \u003cyour_changelog_file\u003e)\" \u003e \u003cyour_changelog_file\u003e\n```\n\nThe `--base-branch` option allows you to filter the PRs by base branch. If omitted, it will default to branch master.\n\nExample:\n\n```sh\n$ echo \"$(github-changelog-generator --base-branch=production)\\n$(tail -n +2 CHANGELOG.md)\" \u003e CHANGELOG.md\n```\n\nThe `--future-release` and `--future-release-tag` options are optional. If your future release tag name is the same as your future release version number, then you can skip `--future-release-tag`.\n\nExample:\n\n```sh\n$ echo \"$(github-changelog-generator --future-release=1.2.3 --future-release-tag=v1.2.3)\\n$(tail -n +2 CHANGELOG.md)\" \u003e CHANGELOG.md\n```\n\nIf you are on a mono-repository, you will need to use `--release-tag-prefix` in order to filter release tags of the package you are targeting. There's also the `--changed-files-prefix` option that may be used to specify the base directory of the package. However, this should be automatic in most cases, except when we are unable to infer the root folder.\n\nExample:\n\n```sh\n$ echo \"$(github-changelog-generator --future-release=my-package@1.2.3 --future-release-tag=my-package@v1.2.3 --release-tag-prefix=my-package@v)\\n$(tail -n +2 CHANGELOG.md)\" \u003e CHANGELOG.md\n```\n\nThe `--owner` and `--repo` options allow you to specify the owner and name of the GitHub repository, respectively. If omitted, they will default to the values found in the project's git config.\n\nExample:\n\n```sh\n$ echo \"$(github-changelog-generator --owner=uphold --repo=github-changelog-generator)\\n$(tail -n +2 CHANGELOG.md)\" \u003e CHANGELOG.md\n```\n\nThe `--labels` option allows you to filter what pull requests are used by their labels. This is useful for repositories with more than one project, by labeling each pull request by what project they belong to, generating a changelog for each project becomes as simple as:\n\nExample:\n\n```sh\n$ echo \"$(github-changelog-generator --labels projectX,general)\\n$(tail -n +2 CHANGELOG.md)\" \u003e CHANGELOG.md\n```\n\nThe `--rebuild` option allows you to fetch the repository's full changelog history.\nStarting on major version 2, the default behavior for the generator is to only create the changelog for the pull requests that come after the latest release,\nso this option allows for backwards compatibility.\n\nExample:\n\n```sh\n$ github-changelog-generator --rebuild \u003e CHANGELOG.md\n```\n\n## Release\n\nThe release process is automated via the [release](https://github.com/uphold/github-changelog-generator/actions/workflows/release.yaml) GitHub workflow. Run it by clicking the \"Run workflow\" button.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuphold%2Fgithub-changelog-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuphold%2Fgithub-changelog-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuphold%2Fgithub-changelog-generator/lists"}