Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document release notes procedure #1705

Open
wants to merge 32 commits into
base: master
Choose a base branch
from

Conversation

GitHK
Copy link
Contributor

@GitHK GitHK commented Sep 5, 2024

Adds documentation how to handle the release notes.
It is important that the procedure is written down, since it's the scrum master's responsibility to enforce it.
This also makes it easier to update.

I have tried to create as much automation as possible in order to aid the scrum master.

Bonus:

  • upgraded old not working .pre-commit-config.yaml config
  • updated user readme in scripts
  • moved some code to the shared utils module inside scripts

TODOs:

  • before committing run entire readme once

Related issues:

@GitHK GitHK self-assigned this Sep 5, 2024
@GitHK GitHK added this to the Eisbock milestone Sep 5, 2024
@GitHK GitHK added the documentation Improvements or additions to documentation label Sep 5, 2024
Copy link
Member

@pcrespov pcrespov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx

  1. please pass a spellchecker to the readme (and in general all the texts that you are also generating with the scripts) :-)
  2. IMO some of the scripts (generating more instructions) are unnecessary, but ok :-)
  3. i find the workflow a bit too manual which IMO reduces the changes to succeed ...

release-notes/README.md Outdated Show resolved Hide resolved
release-notes/README.md Outdated Show resolved Hide resolved
release-notes/README.md Outdated Show resolved Hide resolved
release-notes/README.md Outdated Show resolved Hide resolved
release-notes/README.md Outdated Show resolved Hide resolved
Copy link
Member

@pcrespov pcrespov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Member

@sanderegg sanderegg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, thanks

@GitHK GitHK modified the milestones: Eisbock, MartinKippenberger Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document current release-note-creation approach verbosely
4 participants