quine-global-labs/mirror-cockpit-project-cockpit
1
0
Fork 0
mirror of https://github.com/cockpit-project/cockpit.git synced 2026-11-03 21:49:50 -09:00
Code Issues Projects Releases Packages Wiki Activity

doc: Using the blog post release note automation

Browse source 
We didn't showcase this anywhere and it was kinda just a "if you know
you know" kinda feature, or you looked into the blog post generation
script or release process docs. But for contributors there wasn't a good
way to add a release note when wanted and instead it became a thing we
added when we wanted to.

With this we now also tell the contributors how to add release notes if
they want to, but it is not mandatory for contributions.

Fixes: https://github.com/cockpit-project/cockpit/issues/22485
Signed-off-by: Freya Gustavsson <freya@venefilyn.se>
This commit is contained in:
Freya Gustavsson 2025-11-05 15:32:43 +01:00 committed by Jelle van der Waa
parent 45ff81def3
commit a2916a8099
1 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
HACKING.md
View file

@ -478,6 +478,37 @@ following commands:
Then run it with `Ctrl+R` when the browser is showing an empty tab, e.g.
`about:newtab`. You may need to adjust the positions for your environment.
## Adding a release note in PR
Optional but highly quality of life feature we have relates to automatic
release blog post generation.
There is an automated release note process for PRs where any PRs that include
a label `release-note` and contains a release note segment in the description
will be used when generating the release blog post for https://cockpit-project.org.
To create a release note you need a h2-header at the end of your PR description
where everything underneath will be taken by the automation for the blog
generation. It will also take any images and videos uploaded and add them to
the blog post PR as well. For example:
```md
[...truncated PR description...]
## Release note title
Release note text that will be picked up by automation
<img for release note>
```
You can see this in action in [this cockpit-machines
PR](https://github.com/cockpit-project/cockpit-machines/pull/2268) where we
have an h2-header together with text which in turn was taken by the
automation and shown inside [the blog
post](https://cockpit-project.org/blog/cockpit-347.html) for the release
that included it.
## Debug logging of Cockpit processes
All messages from the various cockpit processes go to the journal and can be