Skip to content

Clean github release notes#1009

Merged
pedro-psb merged 1 commit intopulp:mainfrom
pedro-psb:clean-gh-release2
Feb 26, 2026
Merged

Clean github release notes#1009
pedro-psb merged 1 commit intopulp:mainfrom
pedro-psb:clean-gh-release2

Conversation

@pedro-psb
Copy link
Member

@pedro-psb pedro-psb commented Feb 24, 2026

The changelog generates markup intended for the documentation build enginee (mkdocs). For the github (or any markdown viwer), this pollutes the document.

This adds a script to clean that up before publishing on github.

Continuation of the work of @StopMotionCuber : #1003

Copy link
Contributor

@StopMotionCuber StopMotionCuber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking this up, had an idea that would get rid of regex parsing. Though I have no strong opinions whether that should be pursued or not.


def main():
plugin_name = sys.argv[1]
version_str = ""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, if we're going with sys.argv anyways, one could also think of executing

towncrier build --draft --version $TAG_NAME | .ci/scripts/clean_gh_release_notes.py {{ plugin_name }} $TAG_NAME

in the CI and get rid of regex parsing in favor of passing the version directly to the script

Though both versions would get the job done.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like obsoleting regexes

release_notes.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Has this file been added by accident? I guess this something for tests, which wasn't meant to be committed

The changelog generates markup intended for the documentation build
enginee (mkdocs). For the github (or any markdown viwer), this pollutes
the document.

This adds a script to clean that up before publishing on github.

Co-authored-by: Ruben Simons <r.simons@fz-juelich.de>
@pedro-psb pedro-psb merged commit d925e64 into pulp:main Feb 26, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants