update-release-notes
ActionsLightweight composite action to generate and update release notes for a repository using Gitverse via GitHub action bot
v2
LatestTags
(2)
GitHub actions to generate/update release notes using gitverse
- In your GitHub repository, select the Actions tab and either add or edit a workflow.
- Navigate to
update-release-notesin Marketplace. - Copy and paste the yaml into your workflow.
[OR]
Copy & paste the following workflow definition into your project .github/workflows/update-release-notes.yml
name: Update Release Notes
on:
workflow_dispatch:
release:
types: [ published ]
jobs:
update-release-notes:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v4
with:
python-version: '3.x'
- uses: thevickypedia/update-release-notes@v1
env:
git_token: ${{ secrets.GIT_TOKEN }}| Parameter | Description | Default |
|---|---|---|
git_token |
GitHub token for authentication. | N/A |
source |
Source for release notes. (commit/release) |
release |
commit_message |
Commit message for the release notes upate. | $default |
commit_branch |
Branch to use for commit-based release notes. | $default |
branch |
Branch to push release notes to. | $default |
filename |
Filename for the release notes. | release_notes.rst |
title |
Title for the release notes. | Release Notes |
reverse |
Boolean flag to sort in reverse order. | true |
© Vignesh Rao
Licensed under the MIT License
update-release-notes is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
v2
LatestTags
(2)update-release-notes is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.