{"id":15981176,"url":"https://github.com/hideoo/changelogithub-action","last_synced_at":"2026-05-10T19:18:08.299Z","repository":{"id":85853329,"uuid":"599011632","full_name":"HiDeoo/changelogithub-action","owner":"HiDeoo","description":"GitHub Action to generate changelog for GitHub releases from Conventional Commits.","archived":false,"fork":false,"pushed_at":"2023-02-10T14:10:56.000Z","size":699,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-19T22:41:09.950Z","etag":null,"topics":["changelog","conventional-commits","github","github-actions","release"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/generate-changelog-for-github","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/HiDeoo.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2023-02-08T09:12:06.000Z","updated_at":"2023-12-13T22:20:59.000Z","dependencies_parsed_at":"2023-03-13T06:59:57.678Z","dependency_job_id":null,"html_url":"https://github.com/HiDeoo/changelogithub-action","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2Fchangelogithub-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2Fchangelogithub-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2Fchangelogithub-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2Fchangelogithub-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HiDeoo","download_url":"https://codeload.github.com/HiDeoo/changelogithub-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247234941,"owners_count":20905854,"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","conventional-commits","github","github-actions","release"],"created_at":"2024-10-08T00:41:41.751Z","updated_at":"2026-05-10T19:18:08.266Z","avatar_url":"https://github.com/HiDeoo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003echangelogithub-action 📚\u003c/h1\u003e\n  \u003cp\u003eGitHub Action to generate Changelog for GitHub releases from Conventional Commits.\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/HiDeoo/changelogithub-action/actions/workflows/integration.yml\"\u003e\n    \u003cimg alt=\"Integration Status\" src=\"https://github.com/HiDeoo/changelogithub-action/actions/workflows/integration.yml/badge.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/HiDeoo/changelogithub-action/blob/main/LICENSE\"\u003e\n    \u003cimg alt=\"License\" src=\"https://badgen.net/github/license/HiDeoo/changelogithub-action\" /\u003e\n  \u003c/a\u003e\n  \u003cbr /\u003e\n\u003c/div\u003e\n\n## Features\n\nThis GitHub action is a small wrapper for [`changelogithub`](https://github.com/antfu/changelogithub) to generate Changelog for GitHub releases from Conventional Commits.\n\nCreated by [Anthony Fu](https://github.com/antfu) who deserves all the credits, `changelogithub` is a great tool but is [not a GitHub Action](https://github.com/antfu/changelogithub/issues/5#issuecomment-1154179110) which makes it a bit more difficult to get the newly created release ID or URL as output variables.\n\nThis GitHub Action uses a [slightly patched](/patches/changelogithub%400.12.7.patch) version of `changelogithub` to access the GitHub API response returned when creating a release and outputs the _release ID_, _release URL_ and _release upload URL_ as output variables.\n\n## Usage\n\nYou can also check out the [`changelogithub` documentation](https://github.com/antfu/changelogithub#usage) for more informations.\n\n```yaml\nname: Release\n\non:\n  push:\n    tags:\n      - 'v*.*.*'\n\njobs:\n  release:\n    name: Release\n    runs-on: ubuntu-latest\n    permissions:\n      contents: write\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n        with:\n          fetch-depth: 0\n\n      - name: Install Node.js\n        uses: actions/setup-node@v3\n        with:\n          node-version: 16\n\n      - name: Generate changelog\n        uses: hideoo/changelogithub-action@v1\n        with:\n          token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n\u003e **Note**\n\u003e You can also use the `hideoo/changelogithub-action@v1.x.x` syntax to pin the action to a specific version.\n\n### Inputs\n\nInputs are specified using the `with` keyword. For example:\n\n```yaml\n- uses: hideoo/changelogithub-action@v1\n  with:\n    token: ${{ secrets.GITHUB_TOKEN }}\n    emoji: false\n    prerelease: true\n```\n\nThe following inputs are available:\n\n| Name           | Description                                                                     | Required |\n| -------------- | ------------------------------------------------------------------------------- | :------: |\n| `token`        | The GitHub Token to use.                                                        |    ✅    |\n| `capitalize`   | Capitalize commit messages.                                                     |          |\n| `contributors` | Whether to include contributors in release notes.                               |          |\n| `draft`        | Mark the release as a draft.                                                    |          |\n| `dry`          | Dry run. Skip releasing to GitHub.                                              |          |\n| `emoji`        | Use emojis in section titles.                                                   |          |\n| `from`         | The start commit reference. When not provided, the latest git tag is used.      |          |\n| `github`       | The owner/repository identifier.                                                |          |\n| `group`        | Nest commit messages under their scopes.                                        |          |\n| `name`         | Name of the release.                                                            |          |\n| `prerelease`   | Mark the release as prerelease.                                                 |          |\n| `to`           | The end commit reference. When not provided, the latest commit in HEAD is used. |          |\n\n### Outputs\n\nOutputs can be accessed using the `steps.\u003cstep_id\u003e.outputs.\u003coutput_name\u003e` syntax. For example:\n\n```yaml\n- uses: hideoo/changelogithub-action@v1\n  id: changelog\n  with:\n    token: ${{ secrets.GITHUB_TOKEN }}\n\n- name: Get the release ID\n  run: echo \"The release ID is ${{ steps.changelog.outputs.release_id }}\"\n```\n\nThe following outputs are available:\n\n| Name                 | Description                 |\n| -------------------- | --------------------------- |\n| `release_id`         | The new release ID.         |\n| `release_url`        | The new release URL.        |\n| `release_upload_url` | The new release upload URL. |\n\n## License\n\nLicensed under the MIT License, Copyright © HiDeoo.\n\nSee [LICENSE](https://github.com/HiDeoo/changelogithub-action/blob/main/LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhideoo%2Fchangelogithub-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhideoo%2Fchangelogithub-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhideoo%2Fchangelogithub-action/lists"}