Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ricardoboss/changelog-from-github-releases
Generate a CHANGELOG.md from GitHub Releases
https://github.com/ricardoboss/changelog-from-github-releases
actions changelog release-automation release-notes
Last synced: 18 days ago
JSON representation
Generate a CHANGELOG.md from GitHub Releases
- Host: GitHub
- URL: https://github.com/ricardoboss/changelog-from-github-releases
- Owner: ricardoboss
- License: mit
- Created: 2024-07-04T08:40:38.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-14T04:54:59.000Z (about 1 month ago)
- Last Synced: 2024-10-16T09:19:33.525Z (about 1 month ago)
- Topics: actions, changelog, release-automation, release-notes
- Language: TypeScript
- Homepage:
- Size: 878 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Changelog from GitHub Releases
[](https://github.com/super-linter/super-linter)
[](https://github.com/ricardoboss/changelog-from-github-releases/actions/workflows/check-dist.yml)
[](https://github.com/ricardoboss/changelog-from-github-releases/actions/workflows/codeql-analysis.yml)
[](./badges/coverage.svg)
## Usage
The simplest way to use this action looks like this:
```yaml
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4
- name: Generate CHANGELOG.md
id: changelog
uses: ricardoboss/changelog-from-github-releases@v1
- name: Print CHANGELOG.md
id: print-changelog
run: cat CHANGELOG.md
```
The result will be a `CHANGELOG.md` file that looks like this:
```markdown
# [v2.0.0](https://github.com/example/repo/releases/2) (2024-01-02)
Second release
# [v1.0.0](https://github.com/example/repo/releases/1) (2024-01-01)
First release
```
## Inputs
### `file`
The file to write the changelog to. Defaults to `./CHANGELOG.md`.
### `repository`
The repository to get the releases from. Defaults to `${{ github.repository }}`.
### `token`
The GitHub token to use for authentication. Defaults to `${{ github.token }}`.
### `prerelease`
Whether to include prereleases. Defaults to `false`.
## Outputs
In addition to these outputs, the action also generates the file determined by
the `file` input that contains the generated changelog.
### `changelog`
The generated changelog.
## Example using all inputs
```yaml
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4
- name: Generate CHANGELOG.md
id: changelog
uses: ricardoboss/changelog-from-github-releases@v1
with:
file: './path/to/CHANGELOG.md'
repository: 'owner/repository'
token: '${{ secrets.MY_PAT }}'
prerelease: 'true'
```
## License
The code in this project is licensed under the [MIT License](./LICENSE).
## Alternatives
Consider these alternatives to this action:
- [rhysd/changelog-from-release](https://github.com/rhysd/changelog-from-release)