https://github.com/ponylang/release-notes-bot-action
:horse: Bot to update release notes with new entries
https://github.com/ponylang/release-notes-bot-action
github-action pony-language ponylang release-notes-generateor
Last synced: 5 months ago
JSON representation
:horse: Bot to update release notes with new entries
- Host: GitHub
- URL: https://github.com/ponylang/release-notes-bot-action
- Owner: ponylang
- License: bsd-2-clause
- Created: 2020-05-20T01:19:06.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-06-06T12:55:08.000Z (about 1 year ago)
- Last Synced: 2025-06-09T22:04:19.042Z (about 1 year ago)
- Topics: github-action, pony-language, ponylang, release-notes-generateor
- Language: Python
- Homepage: https://ponylang.io
- Size: 146 KB
- Stars: 1
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Release-notes-bot action
Automatically adds a new release notes entry to the upcoming release notes file once a PR is merged if a corresponding release notes addition file is present and a changelog label was applied to the PR.
Valid changelog labels are:
- changelog - added
- changelog - changed
- changelog - fixed
If no changelog label was applied to the PR, any release notes files in the PR will be deleted.
A repo must have a `.release-notes` directory and a `.release-notes/next-release.md` file for the action to work properly.
To prompt contributors to add release notes, see the [release-notes-reminder-bot-action](https://github.com/ponylang/release-notes-reminder-bot-action).
## Example workflow
```yml
name: Release Notes Bot
on:
push:
branches:
- '**'
tags-ignore:
- '**'
paths-ignore:
- .release-notes/next-release.md
- .release-notes/[0-9]+.[0-9]+.[0-9]+.md
jobs:
release-notes-bot:
runs-on: ubuntu-latest
name: Update release notes
steps:
- name: Update
uses: docker://ponylang/release-notes-bot-action:0.3.10
with:
git_user_name: "Ponylang Main Bot"
git_user_email: "ponylang.main@gmail.com"
env:
API_CREDENTIALS: ${{ secrets.GITHUB_TOKEN }}
```
Note, you do not need to create `GITHUB_TOKEN`. It is already provided by GitHub. You merely need to make it available to the release-notes-bot action.