This GitHub Action extracts a specific version's changelog from a CHANGELOG file. It's designed to help automate the process of fetching release notes or changelog entries for a given version, which can be particularly useful for generating release summaries, notifications, or other workflow automation tasks.
Required The prefix used to identify the version section in the CHANGELOG.
Example: "## Version "
Required The specific version to extract from the CHANGELOG.
Example: "1.4.0"
Optional Path to the CHANGELOG file.
Default: "./CHANGELOG.md"
The extracted changelog section for the specified version.
To use this action, add it as a step in your workflow. Here is a basic example:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Extract Changelog
id: changelog
uses: nickohold/[email protected]
with:
version_prefix: "## Version "
version: "1.4.0"
changelog_path: "./CHANGELOG.md"
# Use the output from the `changelog` step
- name: Get the output
run: echo "The Changelog is ${{ steps.changelog.outputs.changelog }}"Contributions to this project are welcome! Please consider the following guidelines:
- Submit issues for any feature requests, bugs, or documentation improvements.
- When submitting a pull request, please make sure your changes are well-documented and include appropriate test cases.
This project is licensed under the MIT License.