{"id":15651770,"url":"https://github.com/jaywcjlove/changelog-generator","last_synced_at":"2025-04-15T21:22:40.383Z","repository":{"id":37833237,"uuid":"326681632","full_name":"jaywcjlove/changelog-generator","owner":"jaywcjlove","description":"A GitHub Action that compares the commit differences between two branches","archived":false,"fork":false,"pushed_at":"2025-02-06T01:21:09.000Z","size":3483,"stargazers_count":47,"open_issues_count":5,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-11T14:37:57.504Z","etag":null,"topics":["actions","changelog","changelog-generator","github-actions"],"latest_commit_sha":null,"homepage":"https://jaywcjlove.github.io/changelog-generator/","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/jaywcjlove.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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},"funding":{"custom":"https://jaywcjlove.github.io/#/sponsor"}},"created_at":"2021-01-04T12:47:42.000Z","updated_at":"2025-02-06T01:20:19.000Z","dependencies_parsed_at":"2023-01-04T12:15:12.326Z","dependency_job_id":"9aec6688-f179-4f3a-8bd0-4c7d6fc54d17","html_url":"https://github.com/jaywcjlove/changelog-generator","commit_stats":{"total_commits":306,"total_committers":8,"mean_commits":38.25,"dds":0.1405228758169934,"last_synced_commit":"a495456e2cfc62aa361eded8ca659d27b5fe6c61"},"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Fchangelog-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Fchangelog-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Fchangelog-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Fchangelog-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaywcjlove","download_url":"https://codeload.github.com/jaywcjlove/changelog-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248760734,"owners_count":21157419,"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":["actions","changelog","changelog-generator","github-actions"],"created_at":"2024-10-03T12:40:06.508Z","updated_at":"2025-04-15T21:22:40.375Z","avatar_url":"https://github.com/jaywcjlove.png","language":"TypeScript","funding_links":["https://jaywcjlove.github.io/#/sponsor"],"categories":["Browse The Shelves"],"sub_categories":["Repo automation tools"],"readme":"Changelog Generator\n===\n\n[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor)\n[![Build \u0026 Test](https://github.com/jaywcjlove/changelog-generator/actions/workflows/changelog.yml/badge.svg)](https://github.com/jaywcjlove/changelog-generator/actions/workflows/changelog.yml)\n[![Repo Dependents](https://badgen.net/github/dependents-repo/jaywcjlove/changelog-generator)](https://github.com/jaywcjlove/changelog-generator/network/dependents)\n\nThis [Action](https://github.com/actions) returns a markdown formatted changelog between two git references. There are other projects that use milestones, labeled PRs, etc. Those are just to much work for simple projects.\n\n\u003ca target=\"__blank\" href=\"https://github.com/jaywcjlove/changelog-generator/releases\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/1680273/103605228-53636b80-4f4e-11eb-9fa3-c53e7358f645.png\" height=\"320\" alt=\"Changelog Generator\" /\u003e\n\u003c/a\u003e\n\nI just wanted a simple way to populate the body of a GitHub Release.\n\n\n```yml\n- run: echo \"previous_tag=$(git describe --tags --abbrev=0 2\u003e/dev/null || echo '')\" \u003e\u003e $GITHUB_ENV\n- name: Generate changelog\n  id: changelog\n  uses: jaywcjlove/changelog-generator@main\n  if: env.previous_tag\n  with:\n    token: ${{ secrets.GITHUB_TOKEN }}\n    filter-author: (jaywcjlove|小弟调调™|dependabot|renovate\\\\[bot\\\\]|dependabot\\\\[bot\\\\]|Renovate Bot)\n    filter: '[R|r]elease[d]\\s+[v|V]\\d(\\.\\d+){0,2}'\n```\n\nThen you can to use the resulting changelog.\n\n```yml\n- name: Get the changelog\n  run: echo \"${{ steps.changelog.outputs.changelog }}\"\n\n- name: Create Release\n  uses: ncipollo/release-action@v1\n  if: steps.create_tag.outputs.successful == 'true'\n  with:\n    token: ${{ secrets.GITHUB_TOKEN }}\n    name: ${{ steps.create_tag.outputs.version }}\n    tag: ${{ steps.create_tag.outputs.version }}\n    body: |\n      ${{ steps.changelog.outputs.compareurl }}\n\n      ${{ steps.changelog.outputs.changelog }}\n      \n      Document Website: https://raw.githack.com/jaywcjlove/changelog-generator/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html\n```\n\nDefine the log display template ([#111](https://github.com/jaywcjlove/changelog-generator/issues/111#issuecomment-1594085749)).\n\n```yml\n- name: Generate changelog\n  uses: jaywcjlove/changelog-generator@main\n  with:\n    token: ${{ secrets.GITHUB_TOKEN }}\n    filter-author: (jaywcjlove|小弟调调™|dependabot|renovate\\\\[bot\\\\]|dependabot\\\\[bot\\\\])\n    filter: '[R|r]elease[d]\\s+[v|V]\\d(\\.\\d+){0,2}'\n    template: |\n      ## Bugs\n      {{fix}}\n      ## Feature\n      {{feat}}\n      ## Improve\n      {{refactor,perf,clean}}\n      ## Misc \n      {{chore,style,ci||🔶 Nothing change}}\n      ## Unknown\n      {{__unknown__}}\n```\n\nCustomize `type` and `emoji` icons\n\n```yml\n- name: Generate Changelog(custom-emoji test)\n  uses: jaywcjlove/changelog-generator@main\n  with:\n    token: ${{ secrets.GITHUB_TOKEN }}\n    filter-author: (小弟调调™|Renovate Bot)\n    filter: '[R|r]elease[d]\\s+[v|V]\\d(\\.\\d+){0,2}'\n    custom-emoji: 'type🐝,feat💄,fix🆎'\n```\n\n## GETTING STARTED\n\nOnly use the following Git Commit Messages. A simple and small footprint is critical here.\n\n1. 🌟 `feat` Use when you add something entirely new. E.g: `feat(Button): add type props.`\n2. 🐞 `fix` Use when you fix a bug — need I say more? E.g. `fix: Case conversion.`\n3. 📖 `doc`/`docs` Use when you add documentation like README.md, or even inline docs. E.g. `doc(Color): API Interface.`\n4. 💄 `chore` Changes to the build process or auxiliary tools. E.g. `chore(Color): API Interface.`\n5. 🎨 `style` Format (changes that do not affect code execution). E.g. `style(Alert): API Interface.`\n6. 🆎 `type` Typescript type bug fixes. E.g. `type(Alert): fix type error.`\n7. ⛑ `test` Add and modify test cases. E.g. `test(Alert): Add test case.`\n8. 🐝 `refactor` Refactoring (i.e. code changes that are not new additions or bug fixes). E.g. `refactor(Alert): API Interface.`\n9. 🌍 `website` Documentation website changes. E.g. `website(Alert): Add example.`\n10. 🔙 `revert` Revert last commit. E.g. `revert: Add test case.`\n11. 💊 `clean` clean up. E.g. `clean: remove comment code.`\n12. 📈 `perf` Change the code to improve performance. E.g. `perf(pencil): remove graphiteWidth option`\n13. 💢 `ci` Continuous integration related file modification. E.g. `ci: Update workflows config.`\n14. 🧯 `build` Changes that affect the build system or external dependencies (example scopes: gulp, webpack, vite, npm)\n\n```shell\n\u003ctype\u003e(\u003cscope\u003e): \u003cshort summary\u003e\n  │     │         │\n  │     │         └─⫸ Summary in present tense. Not capitalized. No period at the end.\n  │     │\n  │     └─⫸ Commit Scope: \n  │            animations|bazel|benchpress|common|compiler|compiler-cli|core|\n  │            elements|forms|http|language-service|localize|platform-browser|\n  │            platform-browser-dynamic|platform-server|router|service-worker|\n  │            upgrade|zone.js|packaging|changelog|docs-infra|migrations|ngcc|ve|\n  │            devtools....\n  │\n  └─⫸ Commit Type: build|ci|doc|docs|feat|fix|perf|refactor|test\n                    website|chore|style|type|revert\n```\n\n```shell\n\u003ctype\u003e[optional scope]: \u003cdescription\u003e\n\n[optional body]\n\n[optional footer(s)]\n```\n\n## Inputs\n\n- `token` A GITHUB_TOKEN with the ability to pull from the repo in question. This is required. Why do we need `token`? Read more here: [About the GITHUB_TOKEN secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret). Default: `${{ github.token }}`\n- `filter-author` Regular expression filtering author. Example: [`filter-author: (jaywcjlove|小弟调调™|dependabot\\[bot\\]|Renovate Bot)`](https://github.com/jaywcjlove/changelog-generator/blob/f48f63cdb5f3c5d8b6499c6d96e3450ee7bdb9f5/.github/workflows/changelog.yml#L17)\n- `filter` Regular expression filtering changelog. Example: [`filter: '[R|r]elease[d]\\s+[v|V]\\d(\\.\\d+){0,2}'`](https://github.com/jaywcjlove/changelog-generator/blob/b372394a4e7265d4041c479b4d1f515a9c21ec37/.github/workflows/release.yml#L21)\n- `head-ref` The name of the head reference. Default `${{github.sha}}`.\n- `base-ref` The name of the second branch. Defaults to the `tag_name` of the latest GitHub release. *This must be a GitHub release. Git tags or branches will not work.*\n- `original-markdown` Default `true`, Output clean markdown content.\n- `gh-pages` Default `gh-pages`, Specify the branch name to get the hash from\n- `order` Default `asc`, Should the log results be displayed in descending (desc) or ascending (asc) order\n- `path` Only commits containing this file path will be returned.\n- `template` Define the log display template ([#111](https://github.com/jaywcjlove/changelog-generator/issues/111#issuecomment-1594085749)).\n- `show-emoji` Show emoji icons. Default `true`.\n- `custom-emoji` Customize type and emoji icons. Example `type🆎,chore💄,fix🐞`.\n\n## Outputs\n\n- `changelog` Markdown formatted changelog.\n- `compareurl` Comparing two branches to see what’s changed or to start a new pull request.\n- `tag` Tag name `v1.0.0`.\n- `version` The version number of the tag created. example: `1.0.0`\n- `branch` Branch name.\n- `gh-pages-hash` Output to the latest hash of the specified branch. example: `cc088c571f86fe222ff68f565`\n- `gh-pages-short-hash` Specify the branch name to get the short-hash from. example: `cc088c5`\n\n## Troubleshooting\n\n#### Error not found\n\n```\nError: Not Found\n```\n\nIf you are seeing this error its likely that you do not yet have a GitHub release. You might have a git tag and that shows up in the release tab. The\nAPI this Action uses only works with GitHub Releases. Convert one of your tags to a release and you'll be on your way. You can check out how this\nrepository uses this action and GitHub releases for an [example](https://github.com/jaywcjlove/changelog-generator/blob/600f36ff605c63a74a264ab324247f0c392bf7a2/.github/workflows/changelog.yml#L12-L18).\n\nYou can also set `env.previous_tag` to `\"\"` or the previous tag if it exists, and run the step conditionally. If there is no previous tag, the step will not run:\n\n```diff\n+- run: echo \"previous_tag=$(git describe --tags --abbrev=0 2\u003e/dev/null || echo '')\" \u003e\u003e $GITHUB_ENV\n - name: Generate changelog\n   id: changelog\n   uses: jaywcjlove/changelog-generator@main\n+  if: env.previous_tag\n   with:\n    token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## See also\n\n- [Create Tags From](https://github.com/jaywcjlove/create-tag-action) Auto create tags from commit or package.json.\n- [Github Action Contributors](https://github.com/jaywcjlove/github-action-contributors) Github action generates dynamic image URL for contributor list to display it!\n- [Create Coverage Badges](https://github.com/jaywcjlove/coverage-badges-cli) Create coverage badges from coverage reports. (no 3rd parties servers)\n- [Generated Badges](https://github.com/jaywcjlove/generated-badges) Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)\n\n## Acknowledgements\n\n- [@conventional-changelog/conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular#angular-convention).\n- [@homeday-de/github-action-changelog-generator](https://github.com/homeday-de/github-action-changelog-generator).\n- [@jessicalostinspace/commit](https://github.com/jessicalostinspace/commit-difference-action).\n- [@metcalfc/changelog-generator](https://github.com/metcalfc/changelog-generator).\n\n## Example\n\n- [uiwjs/react-md-editor](https://github.com/uiwjs/react-md-editor/blob/e3293bca45bff08110ef5e9119d907db2ec95baa/.github/workflows/ci.yml#L30-L37)\n- [uiwjs/react-code-preview](https://github.com/uiwjs/react-code-preview/blob/fb9829440a21fddbb57100db62ae113be3c01161/.github/workflows/ci.yml#L42-L50)\n- [uiwjs/react-amap](https://github.com/uiwjs/react-amap/blob/550599511bdf42260580fad380c4c9741142e572/.github/workflows/ci.yml#L29-L36)\n- [uiwjs/react-heat-map](https://github.com/uiwjs/react-heat-map/blob/f828826111dc6d79249fdd106648d835ae8e47ba/.github/workflows/ci.yml#L29-L36)\n- [More Examples...](https://github.com/jaywcjlove/changelog-generator/network/dependents)\n\n## Contributors\n\nAs always, thanks to our amazing contributors!\n\n\u003ca href=\"https://github.com/jaywcjlove/changelog-generator/graphs/contributors\"\u003e\n  \u003cimg src=\"https://jaywcjlove.github.io/changelog-generator/CONTRIBUTORS.svg\" /\u003e\n\u003c/a\u003e\n\nMade with [action-contributors](https://github.com/jaywcjlove/github-action-contributors).\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaywcjlove%2Fchangelog-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaywcjlove%2Fchangelog-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaywcjlove%2Fchangelog-generator/lists"}