ffurrer2 / extract-release-notes Goto Github PK
View Code? Open in Web Editor NEWA GitHub Action to extract release notes from a "Keep a Changelog" formatted changelog file
License: MIT License
A GitHub Action to extract release notes from a "Keep a Changelog" formatted changelog file
License: MIT License
Since this action is Docker-based it can run only on Linux. Would there be an interest to change it to a JS one in order to enable it on other platforms?
I can make a PR but I'd like to know beforehand if there's an interest or should I write a different action.
It would be nice if the action were to extract the content between the first and second H2 if a parameter such as prerelease: true
were set.
For example,
- name: Extract release notes
id: extract-release-notes
uses: ffurrer2/extract-release-notes@v1
prerelease: ${{ env.PRERELEASE }}
This would interact nicely with actions/upload-release-asset
.
Thank you for developing this action; it has been very useful!
However, I recently encountered an issue where I created a release note for an incorrect tag. If this action could also output the H2
line, it could then be compared with the tag specified in github.ref_name
in a subsequent step, preventing such mismatches.
Thank you for considering this request.
extract-release-notes/src/index.js
Line 57 in 9237796
I have a Keep A Changelog formatted CHANGELOG.md file; running this action with all default settings fails with
Error: Reduce of empty array with no initial value
Here is the job and relevant files:
Failed run: https://github.com/ajalt/colormath/actions/runs/8727198863/job/23944191785
Workflow file: https://github.com/ajalt/colormath/blob/4a0cc9796c743cb4965407204ee63b40aaf22fca/.github/workflows/release.yml#L25-L27
Changelog: https://github.com/ajalt/colormath/blob/4a0cc9796c743cb4965407204ee63b40aaf22fca/CHANGELOG.md?plain=1
When running workflow, there is a warning:
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: ffurrer2/extract-release-notes@v1. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.
So please consider migrate to Node 20.
Thanks!
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.