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

Store release information in public #1250

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

matsduf
Copy link
Contributor

@matsduf matsduf commented Apr 3, 2024

Purpose

Add release information to the public document path. This PR is not to be merged. It is to show a proposal that would be executed at an upcoming release for that release.

File "public/RELEASE.md" is added. The file should be updated at release time with the release information of the latest release (and not including previous releases). The content is to be directly copied to the Github release page, e.g. https://github.com/zonemaster/zonemaster/releases/tag/v2023.2.1. No edits should be needed.

SUMMARY.md has also been updated with a link to the RELEASE.md file.

I built a "book" and the file works well into the book.

How to test this PR

Review. Build a "book" following the instruction in https://github.com/zonemaster/zonemaster?tab=readme-ov-file#documentation.

@matsduf matsduf added this to the v2024.1 milestone Apr 3, 2024
@mattias-p
Copy link
Member

This looks really nice.

Perhaps rename RELEASE.md to RELEASES.md and keep a history of all releases in the same file, or of all releases up to a certain point (e.g. v2023.2.1 and newer). I'm not sure if there's huge value in this but it just feels a bit weird to me to remove the details of the last release every time we make a new one.

@matsduf
Copy link
Contributor Author

matsduf commented Apr 8, 2024

My idea is exactly to keep only the latest release notes in the file, and refer to Github release notes for previous releases. Then the content will be exactly the same as is entered in Github, and the focus will be on the latest release.

@mattias-p
Copy link
Member

Fair enough, I reckoned as much. I had a different idea and I wanted to raise it.

tgreenx
tgreenx previously approved these changes Apr 30, 2024
docs/public/README.md Outdated Show resolved Hide resolved
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
@matsduf
Copy link
Contributor Author

matsduf commented May 2, 2024

This PR will not be merged. It will be used as model at release time.

@tgreenx and @mattias-p, please review again.

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

Successfully merging this pull request may close these issues.

None yet

4 participants