ci: automatically tag contributors in GitHub release notes#10074
ci: automatically tag contributors in GitHub release notes#10074
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
anakin87
changed the title
anakin87
force-pushed
the
github-relnotes-add-contributors
branch
from
43a4489 to
80bddcb
Compare
| uses: docker://pandoc/core:3.8 | ||
| with: | ||
| args: "--from rst --to markdown_github --no-highlight relnotes.rst -o relnotes.md --wrap=none" | ||
| args: "--from rst --to gfm --syntax-highlighting=none --wrap=none relnotes.rst -o relnotes.md" |
There was a problem hiding this comment.
some arguments were deprecated
| bodyFile: "relnotes.md" | ||
| prerelease: ${{ steps.version.outputs.current_pre_release }} | ||
| bodyFile: "enhanced_relnotes.md" | ||
| prerelease: ${{ steps.version.outputs.current_pre_release != '' }} |
There was a problem hiding this comment.
prerelease should be a boolean. The current approach was not working to set a version as pre-release.
anakin87
requested review from
mpangrazzi and
vblagoje
and removed request for
a team
mpangrazzi
left a comment
mpangrazzi
left a comment
There was a problem hiding this comment.
Looks good! Left two minor comments.
| uses: docker://pandoc/core:3.8 | ||
| with: | ||
| args: "--from rst --to markdown_github --no-highlight relnotes.rst -o relnotes.md --wrap=none" | ||
| args: "--from rst --to gfm --syntax-highlighting=none --wrap=none relnotes.rst -o relnotes.md" |
There was a problem hiding this comment.
Here we can also do something like:
"--from rst --to gfm --syntax-highlighting=none --wrap=none relnotes.rst -o enhanced_relnotes.md"
to save the copy step below. Your choice!
There was a problem hiding this comment.
Ah, unfortunately pandoc creates a markdown files that cannot be later modified (wrong permissions).
I also tried to run chmod and I got other permission issues. I am creating the copy for this reason.
If you have better ideas, feel free to share.
There was a problem hiding this comment.
ok, let's then leave things as is (since it's working). I would add a comment about that, maybe next time we could try to investigate better.
| uses: docker://pandoc/core:3.8 | ||
| with: | ||
| args: "--from rst --to markdown_github --no-highlight relnotes.rst -o relnotes.md --wrap=none" | ||
| args: "--from rst --to gfm --syntax-highlighting=none --wrap=none relnotes.rst -o relnotes.md" |
There was a problem hiding this comment.
ok, let's then leave things as is (since it's working). I would add a comment about that, maybe next time we could try to investigate better.
|
I didn't even know we have this generate notes action, I thought we were supposed to do this step manually?! |
Release notes are automatically generated but contributors were manually added and tagged. |
3 participants
Related Issues
Proposed Changes:
How did you test it?
Tested on #10073 (PR on the v2.20.x branch). Check out the debug step of this workflow run: https://github.com/deepset-ai/haystack/actions/runs/19302188326/job/55199499137
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.