Add dedicated publish config for GitHub releases#7279
Add dedicated publish config for GitHub releases#7279StopMotionCuber wants to merge 1 commit intopulp:mainfrom
Conversation
|
Hey, thanks for the contribution. 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 Do you want to submit a PR there? ps: we should really generate clean changelogs and inject those special marks on docs build time. |
|
Yes, just submitted the PR there. Then consider this one superseeded. |
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
sedmagic 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