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

Adopt Protokolo #966

Open
2 tasks
carmenbianca opened this issue Apr 27, 2024 · 2 comments
Open
2 tasks

Adopt Protokolo #966

carmenbianca opened this issue Apr 27, 2024 · 2 comments

Comments

@carmenbianca
Copy link
Member

I wrote Protokolo.

It solves problems for me. Copying from its README:

Change logs are [a really good idea](https://keepachangelog.com/).
Unfortunately, they are also a bit of a pain when combined with version control:

- Different merge requests all edit the same area in CHANGELOG, inevitably
  resulting in merge conflicts.
- If a section for an unreleased version does not yet exist in the main branch's
  CHANGELOG (typically shortly after release), feature branches must create this
  section. If multiple feature branches do this, you get more merge conflicts.
- Old merge requests, when merged, sometimes add their change log entry to the
  section of a release that is already published.

Life would be a lot easier if you didn't have to deal with these problems.

Enter Protokolo
([Esperanto for 'report' or 'minutes'](https://vortaro.net/#protokolo)). The
idea is very simple: for every change log entry, create a new file. Finally,
just before release, compile the contents of those files into a new section in
CHANGELOG, and delete the files.

Let's use it after the next release.

Some things that are needed:

  • Creating the necessary configuration with protokolo init (and manually editing CHANGELOG.md to include <!-- protokolo-section-tag -->)
  • Instructions in CONTRIBUTING.md
@nicorikken
Copy link
Member

I like the approach, quite simple. An alternative approach I see in projects is to generate a changelog as part of creating a release. This can be automated using tools. If we want to keep creating changelog entries as part of the pull-requests I think the approach supported by Protokolo is a nice one.

@carmenbianca
Copy link
Member Author

I don't like generating change logs from VCS history. Hand-curated change logs are so so so much better, even if they're a touch more work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants