Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arpitbhalla/monorepo-changelog
Github Action for :book: PR-based changelog generator for monorepo
https://github.com/arpitbhalla/monorepo-changelog
changelog github github-actions lerna monorepo release-notes
Last synced: about 1 month ago
JSON representation
Github Action for :book: PR-based changelog generator for monorepo
- Host: GitHub
- URL: https://github.com/arpitbhalla/monorepo-changelog
- Owner: arpitBhalla
- Created: 2021-11-07T15:20:30.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-25T08:48:18.000Z (over 2 years ago)
- Last Synced: 2024-09-14T20:37:47.681Z (2 months ago)
- Topics: changelog, github, github-actions, lerna, monorepo, release-notes
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/monorepo-changelog-with-template
- Size: 1.28 MB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
Generate PR based changelog or release-notes for multi-scope projects with templates
## Usage
```yml
- uses: arpitBhalla/monorepo-changelog@master
with:
GITHUB_AUTH: "${{ secrets.GITHUB_TOKEN }}"
from: "1.2.0"
```
See [example](#example)
## Configuration
You can configure by adding a changelog key to the package.json file of your project:
```jsonc
// ./package.json
{
// ...
"changelog": {
"labels": {
"PR: Breaking Change": "Breaking Change",
"PR: Feature": "Feature",
"PR: Bug": "Bug fix",
"PR: Maintenance": "Maintenance",
"PR: Docs": "Docs",
"PR: Refactoring": "Refactoring"
},
"scopes": {
"native-app": "Native App",
"website/docs": "Docs"
}
}
}
```
### Input
| Action | Description | Default |
| ------ | ----------- | ------- |
| `GITHUB_AUTH` **(required)**| Personal Access Token with read permission | |
| `group-by` | | `labels` |
| `from` | The current version of the project (SHA or Tag) | |
| `to` | The next version of the project (SHA or Tag) | |
| `template` | Handlebar template for Changelog | |
| `version_name` | Title for unreleased commits (e.g. Unreleased) | `Unreleased` |
| `repo` | Your `org/repo` on GitHub (automatically inferred from the package.json file) | |
| `language` | Language of the changelog | `Markdown` |
### Output
| Action | Description |
| ------ | ----------- |
| `changelog` | Generated changelog |
## Example
### Github Action
```yml
# .github/workflows/changelog.yml
name: "generate changelog"
on:
push:
branches:
- main
jobs:
changelog:
runs-on: ubuntu-latest
steps:
# To reference old commits, fetch-depth: 0 is required.
- uses: actions/checkout@v2
with:
fetch-depth: 0
- uses: arpitBhalla/monorepo-changelog@master
id: generate
with:
GITHUB_AUTH: "${{ secrets.GITHUB_TOKEN }}"
from: "1.2.0"
to: "origin/main"
template: |
{{#each .}}
## {{releaseTitle}} (__{{releaseDate}}__)
{{#each labels}}
### {{ name }}
{{#each scopes }}
#### \`{{name}}\`
{{#each changes}}
- [#{{id}}]({{html_url}}) {{title}} by @{{author}}
{{/each}}
{{/each}}
---
{{/each}}
Thanks to {{contributorCount}} contributors namely {{#each contributors}}[@{{login}}]({{url}}){{#unless @last}},{{/unless}} {{/each}}
{{/each }}
- run: echo "${{steps.generate.outputs.changelog}}"
```
### Output
```md
## Unreleased (2021-05-27)
### Feature
#### \`Native App\`
- [#18](https://github.com/{{owner}}/{{repo}}/pull/18) chore(yarn): add lerna-changelog ([@{{owner}}](https://github.com/{{owner}}))
### Maintenance
#### \`Native App\`
- [#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))
- [#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))
#### \`Docs\`
- [#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))
Thanks to 1 contributors namely [@arpitBhalla](https://github.com/arpitBhalla)
```
## Template for Changelog
### Template configuration
| Key | Description |
| -------- | --------------------- |
| `labels` | Map of label to scope |
| `scopes` | Map of scope to label |
### Default Template
```handlebars
{{#each .}}
## {{releaseTitle}}
__{{releaseDate}}__
{{#each labels}}
### {{ name }}
{{#each scopes }}
#### \`{{name}}\`
{{#each changes}}
- [#{{id}}]({{html_url}}) {{title}} by @{{author}}
{{/each}}
{{/each}}
{{/each}}
Thanks to {{contributorCount}} contributors namely {{#each contributors}}[@{{login}}]({{url}}){{#unless @last}},{{/unless}} {{/each}}
{{/each }}
```
### Output for this template
See [Ouput](#output)
## Acknowledgements
- [lerna/lerna-changelog](https://github.com/lerna/lerna-changelog)