{"id":16537151,"url":"https://github.com/arpitbhalla/monorepo-changelog","last_synced_at":"2025-10-28T13:31:17.382Z","repository":{"id":65158951,"uuid":"425539018","full_name":"arpitBhalla/monorepo-changelog","owner":"arpitBhalla","description":"Github Action for :book: PR-based changelog generator for monorepo","archived":false,"fork":false,"pushed_at":"2022-05-25T08:48:18.000Z","size":1339,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-09-14T20:37:47.681Z","etag":null,"topics":["changelog","github","github-actions","lerna","monorepo","release-notes"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/monorepo-changelog-with-template","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arpitBhalla.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"arpitbhalla","patreon":null,"open_collective":"arpitbhalla","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2021-11-07T15:20:30.000Z","updated_at":"2023-11-05T10:46:58.000Z","dependencies_parsed_at":"2023-01-05T04:51:55.088Z","dependency_job_id":null,"html_url":"https://github.com/arpitBhalla/monorepo-changelog","commit_stats":{"total_commits":25,"total_committers":2,"mean_commits":12.5,"dds":"0.040000000000000036","last_synced_commit":"68bed1c1dfcf0ad8883c041470e32ceb2e42f3d8"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arpitBhalla%2Fmonorepo-changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arpitBhalla%2Fmonorepo-changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arpitBhalla%2Fmonorepo-changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arpitBhalla%2Fmonorepo-changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arpitBhalla","download_url":"https://codeload.github.com/arpitBhalla/monorepo-changelog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219859516,"owners_count":16556035,"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","lerna","monorepo","release-notes"],"created_at":"2024-10-11T18:34:57.543Z","updated_at":"2025-10-28T13:31:16.750Z","avatar_url":"https://github.com/arpitBhalla.png","language":"TypeScript","funding_links":["https://github.com/sponsors/arpitbhalla","https://opencollective.com/arpitbhalla"],"categories":[],"sub_categories":[],"readme":"Generate PR based changelog or release-notes for multi-scope projects with templates\n\n## Usage\n\n```yml\n- uses: arpitBhalla/monorepo-changelog@master\n  with:\n    GITHUB_AUTH: \"${{ secrets.GITHUB_TOKEN }}\"\n    from: \"1.2.0\"\n```\n\nSee [example](#example)\n\n## Configuration\n\nYou can configure by adding a changelog key to the package.json file of your project:\n\n```jsonc\n// ./package.json\n{\n  // ...\n  \"changelog\": {\n    \"labels\": {\n      \"PR: Breaking Change\": \"Breaking Change\",\n      \"PR: Feature\": \"Feature\",\n      \"PR: Bug\": \"Bug fix\",\n      \"PR: Maintenance\": \"Maintenance\",\n      \"PR: Docs\": \"Docs\",\n      \"PR: Refactoring\": \"Refactoring\"\n    },\n    \"scopes\": {\n      \"native-app\": \"Native App\",\n      \"website/docs\": \"Docs\"\n    }\n  }\n}\n```\n\n\u003c!--input-start---\u003e\n### Input\n| Action | Description | Default |\n| ------ | ----------- | ------- |\n| `GITHUB_AUTH` **(required)**| Personal Access Token with read permission |  |\n| `group-by` |  | `labels` |\n| `from` | The current version of the project (SHA or Tag) |  |\n| `to` | The next version of the project (SHA or Tag) |  |\n| `template` | Handlebar template for Changelog |  |\n| `version_name` |  Title for unreleased commits (e.g. Unreleased) | `Unreleased` |\n| `repo` | Your `org/repo` on GitHub (automatically inferred from the package.json file) |  |\n| `language` | Language of the changelog | `Markdown` |\n\n### Output\n| Action | Description |\n| ------ | ----------- |\n| `changelog` | Generated changelog |\n\u003c!--input-end---\u003e\n\n## Example\n\n### Github Action\n\n```yml\n# .github/workflows/changelog.yml\nname: \"generate changelog\"\non:\n  push:\n    branches:\n      - main\njobs:\n  changelog:\n    runs-on: ubuntu-latest\n    steps:\n      # To reference old commits, fetch-depth: 0 is required.\n      - uses: actions/checkout@v2\n        with:\n          fetch-depth: 0\n      - uses: arpitBhalla/monorepo-changelog@master\n        id: generate\n        with:\n          GITHUB_AUTH: \"${{ secrets.GITHUB_TOKEN }}\"\n          from: \"1.2.0\"\n          to: \"origin/main\"\n          template: |\n            {{#each .}}\n            ## {{releaseTitle}} (__{{releaseDate}}__)\n\n            {{#each labels}}\n            ###  {{ name }}\n            {{#each scopes }}\n            #### \\`{{name}}\\`\n            {{#each changes}}\n            - [#{{id}}]({{html_url}}) {{title}} by @{{author}}\n            {{/each}}\n            {{/each}}\n            ---\n            {{/each}}\n\n            Thanks to {{contributorCount}} contributors namely {{#each contributors}}[@{{login}}]({{url}}){{#unless @last}},{{/unless}} {{/each}}\n            {{/each }}\n      - run: echo \"${{steps.generate.outputs.changelog}}\"\n```\n\n### Output\n\n```md\n## Unreleased (2021-05-27)\n\n### Feature\n\n#### \\`Native App\\`\n\n- [#18](https://github.com/{{owner}}/{{repo}}/pull/18) chore(yarn): add lerna-changelog ([@{{owner}}](https://github.com/{{owner}}))\n\n### Maintenance\n\n#### \\`Native App\\`\n\n- [#1](https://github.com/{{owner}}/{{repo}}/pull/1) Bump @types/node from 14.14.9 to 15.3.0 ([@dependabot[bot]](https://github.com/apps/dependabot))\n- [#2](https://github.com/{{owner}}/{{repo}}/pull/2) Bump @actions/core from 1.2.6 to 1.2.7 ([@dependabot[bot]](https://github.com/apps/dependabot))\n\n#### \\`Docs\\`\n\n- [#3](https://github.com/{{owner}}/{{repo}}/pull/3) Bump eslint-plugin-jest from 24.1.3 to 24.3.6 ([@dependabot[bot]](https://github.com/apps/dependabot))\n\nThanks to 1 contributors namely [@arpitBhalla](https://github.com/arpitBhalla)\n```\n\n## Template for Changelog\n\n### Template configuration\n\n| Key      | Description           |\n| -------- | --------------------- |\n| `labels` | Map of label to scope |\n| `scopes` | Map of scope to label |\n\n### Default Template\n\n```handlebars\n{{#each .}}\n\n## {{releaseTitle}}\n\n__{{releaseDate}}__\n\n{{#each labels}}\n\n###  {{ name }}\n\n{{#each scopes }}\n\n#### \\`{{name}}\\`\n\n{{#each changes}}\n- [#{{id}}]({{html_url}}) {{title}} by @{{author}}\n{{/each}}\n{{/each}}\n\n{{/each}}\n\nThanks to {{contributorCount}} contributors namely {{#each contributors}}[@{{login}}]({{url}}){{#unless @last}},{{/unless}} {{/each}}\n\n{{/each }}\n```\n\n### Output for this template\n\nSee [Ouput](#output)\n\n## Acknowledgements\n\n- [lerna/lerna-changelog](https://github.com/lerna/lerna-changelog)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farpitbhalla%2Fmonorepo-changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farpitbhalla%2Fmonorepo-changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farpitbhalla%2Fmonorepo-changelog/lists"}