Skip to content

Commit 9e3f3f0

Browse files
jellyVenefilyn
andauthored
_scripts: rewrite generate release notes into Python (#837)
Most of our team knows Python better then Ruby, so it will be easier to enhance edit and fix the script written in Python. This also removes the need to run it with a Ruby development container. Signed-off-by: Freya Gustavsson <[email protected]> Co-authored-by: Freya Gustavsson <[email protected]>
1 parent c8b8a2d commit 9e3f3f0

File tree

3 files changed

+470
-383
lines changed

3 files changed

+470
-383
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,19 @@ All blog posts belong in the `_posts` directory and must be formatted with the y
216216

217217
In addition, every blog post needs to have Frontmatter including the fields `title` and `date` (which should be the same as the filename's date) and should also include `author` to give the person credit (as well as to show up under the author on the authors page). In addition, a blog post may have `tags` and a `category`, but they're not necessary (only suggested).
218218

219+
To make this process easier we have `_scripts/generate-release-notes` which will take release notes from all our Cockpit repos and generate a blog post for you.
220+
221+
```bash
222+
_scripts/generate-release-notes --user YourAuthorName
223+
```
224+
225+
For all arguments check `--help` section
226+
227+
```bash
228+
_scripts/generate-release-notes --help
229+
```
230+
231+
219232
#### Blog Authors
220233

221234
While not necessary, it is suggested to use nicknames for authors in the Frontmatter of blog posts.

0 commit comments

Comments
 (0)