Don't require version number for release notes before release #458

New Issue

iexos · 2023-06-29T13:16:33Z

iexos commented

2023-06-29 13:16:33 +00:00

I feel that the process of making release notes doesn't go well with doing pull requests, as I cannot know for sure what the version of the next release will be when creating it. I came up with two options to handle this:

Have a single file for release notes

Keep a file RELEASE_NOTES.md (or similar) in the repo (include in sample project)
Add notes I want to communicate to operators to the top of the file, above any existing headline
abra recipe sync: check if there are entries above the last headline. If there is, insert a headline at the top with the new version number
abra app upgrade: print all text for headlines relevant for the upgrade

Backwards compatible approach

An alternative that is backwards compatible with current abra app upgrade could be to write the notes into e.g. release/unreleased, which abra recipe sync renames to the new version number.

Thoughts

I'd prefer the first option:

easier to find and read (only one file, with markdown ending)
no frequent creation/deletion of the same file in the repo, diff feels smaller
no confusion with the current workflow

Please share your thoughts! No official proposal yet, though I imagine this would be medium size?

I feel that the process of making release notes doesn't go well with doing pull requests, as I cannot know for sure what the version of the next release will be when creating it. I came up with two options to handle this: ### Have a single file for release notes 1. Keep a file RELEASE_NOTES.md (or similar) in the repo (include in sample project) 2. Add notes I want to communicate to operators to the top of the file, above any existing headline 3. `abra recipe sync`: check if there are entries above the last headline. If there is, insert a headline at the top with the new version number 4. `abra app upgrade`: print all text for headlines relevant for the upgrade ### Backwards compatible approach An alternative that is backwards compatible with current `abra app upgrade` could be to write the notes into e.g. `release/unreleased`, which `abra recipe sync` renames to the new version number. ### Thoughts I'd prefer the first option: - easier to find and read (only one file, with markdown ending) - no frequent creation/deletion of the same file in the repo, diff feels smaller - no confusion with the current workflow Please share your thoughts! No official proposal yet, though I imagine this would be medium size?

decentral1se added the

question

abra

labels 2023-06-29 14:42:16 +00:00

decentral1se commented

2023-06-29 14:46:38 +00:00

Ah, that's true! I think we originally thought of the current workflow as as matching the "I'm writing the notes now AND I'm making the release now". But for this "I'm gonna make the release later" scenario, it is indeed weird.

I'm a bit wary of the single file approach since it'll make the code more involved and leave us open to parsing errors when things are not formatted correctly. We could get abra to concatenate and list all changes via a command tho?

I like the releases/unreleased approach! And abra throwing them in a matching version file if it finds it seems Simple and Good.

Thanks for opening this! There's my 2 cents so far anyway 😺

Ah, that's true! I think we originally thought of the current workflow as as matching the "I'm writing the notes now AND I'm making the release now". But for this "I'm gonna make the release later" scenario, it is indeed weird. I'm a bit wary of the single file approach since it'll make the code more involved and leave us open to parsing errors when things are not formatted correctly. We could get `abra` to concatenate and list all changes via a command tho? I like the `releases/unreleased` approach! And `abra` throwing them in a matching version file if it finds it seems Simple and Good. Thanks for opening this! There's my 2 cents so far anyway 😺

decentral1se commented

2024-03-27 06:38:51 +00:00

releases/next available in the 0.9.x series of abra and docs in https://docs.coopcloud.tech/maintainers/handbook/#how-do-i-write-version-release-notes

`releases/next` available in the 0.9.x series of `abra` and docs in https://docs.coopcloud.tech/maintainers/handbook/#how-do-i-write-version-release-notes

decentral1se closed this issue

2024-03-27 06:38:51 +00:00

Sign in to join this conversation.

No Milestone

No project

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: coop-cloud/organising#458