File tree Expand file tree Collapse file tree 1 file changed +31
-0
lines changed
Expand file tree Collapse file tree 1 file changed +31
-0
lines changed Original file line number Diff line number Diff line change @@ -481,6 +481,37 @@ following commands:
481481Then run it with ` Ctrl+R ` when the browser is showing an empty tab, e.g.
482482` about:newtab ` . You may need to adjust the positions for your environment.
483483
484+ ## Adding a release note in PR
485+
486+ Optional but highly quality of life feature we have relates to automatic
487+ release blog post generation.
488+
489+ There is an automated release note process for PRs where any PRs that include
490+ a label ` release-note ` and contains a release note segment in the description
491+ will be used when generating the release blog post for https://cockpit-project.org .
492+
493+ To create a release note you need a h2-header at the end of your PR description
494+ where everything underneath will be taken by the automation for the blog
495+ generation. It will also take any images and videos uploaded and add them to
496+ the blog post PR as well. For example:
497+
498+ ``` md
499+ [...truncated PR description...]
500+
501+ ## Release note title
502+
503+ Release note text that will be picked up by automation
504+
505+ <img for release note>
506+ ```
507+
508+ You can see this in action in [ this cockpit-machines
509+ PR] ( https://github.com/cockpit-project/cockpit-machines/pull/2268 ) where we
510+ have an h2-header together with text which in turn was taken by the
511+ automation and shown inside [ the blog
512+ post] ({{ site.baseurl }}/blog/cockpit-347.html) for the release
513+ that included it.
514+
484515## Debug logging of Cockpit processes
485516
486517All messages from the various cockpit processes go to the journal and can be
You can’t perform that action at this time.
0 commit comments