Skip to content

Add dedicated publish config for GitHub releases#7279

Closed
StopMotionCuber wants to merge 1 commit intopulp:mainfrom
StopMotionCuber:improve-docs
Closed

Add dedicated publish config for GitHub releases#7279
StopMotionCuber wants to merge 1 commit intopulp:mainfrom
StopMotionCuber:improve-docs

Conversation

@StopMotionCuber
Copy link

@StopMotionCuber StopMotionCuber commented Feb 4, 2026

Release notes are done for GitHub since a bit of time, but the towncrier template contains some metadata that is probably useful for the Pulp docs, but horrible for the GitHub release pages. Emphasizing the "cry" in towncrier or something.

I've modified the template for the purpose of GitHub releases to not have that metadata in there. Additionally this is also linking to the pulpcore docs.

I did a release on my fork, to give an example on how this would look.

My implementation is duplicating the configuration at 2 places (2 towncrier configs, 2 towncrier templates). This could also be done by some sed magic for the towncrier config (during gh publish process) and making the template more complicated, like more conditional rendering instead of a second template. Not sure what is the better path here.

📜 Checklist

  • Commits are cleanly separated with meaningful messages (simple features and bug fixes should be squashed to one commit)
  • A changelog entry or entries has been added for any significant changes
  • Follows the Pulp policy on AI Usage
  • (For new features) - User documentation and test coverage has been added

@pedro-psb
Copy link
Member

pedro-psb commented Feb 4, 2026

Hey, thanks for the contribution.
The final notes look good. IHO we should use a script to cleanup the release notes generated, its simple enough.
It could be a python script in .ci/scripts, we have a collection of utility scripts there.

But more importantly, the Pulp project has a "managed CI" to keep workflows consistent across plugins x supported-branches. There is a CI worfklow that runs regurarly and runs the plugin_template utility on all plugins/supported-branches, so these hardcoded changes here would be overriden on the next update.

It's not so complicated, there is a template tree at template/github which generates/updates files. It has the same structure you will see in pulpcore, for example. Having the plugin_template and pulpcore as siblings repositories you can test it with cd plugin_template && /plugin_template.py --github pulpcore and it will apply the template on your pulpcore checkout.

Do you want to submit a PR there?


ps: we should really generate clean changelogs and inject those special marks on docs build time.
Although a simple idea, migrating that now is not trivial for all plugins, so let's stick with this.

@StopMotionCuber
Copy link
Author

Yes, just submitted the PR there. Then consider this one superseeded.

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.

2 participants