move RELEASING.md to a GitHub wiki

[gdams]

Move RELEASING.md into a Wiki as it would be so much easier to keep up to date and in my opinion changes to it shouldn’t require a 2 person review flow

Wiki can be found at https://github.com/adoptium/temurin-build/wiki/Temurin-Release-Guide

[github-actions[bot]]

Thank you for creating a pull request! If you have not done so already, please familiarise yourself with our Contributing Guidelines and FAQ, even if you have contributed to the Adoptium project before. GitHub actions will now run a set of jobs against your PR that will lint and unit test your changes. Keep an eye out for the results from these on the latest commit you submitted. For more information, please see our testing documentation.

[judovana]

I agree, I'm wathcing the diffs too. Also the changes to docs comes together with code changes.

I think there is a way to keep wiki in sources, and so to make PRs mandatory for them, and still have wiki as read only view on them. Cant his be set up?

-- Mgr. Jiri Vanek @.***

---------- Původní e-mail ---------- Od: Stewart X Addison @.> Komu: adoptium/temurin-build @.> Kopie: Subscribed @.***> Datum: 11. 10. 2024 15:23:02 Předmět: Re: [adoptium/temurin-build] move RELEASING.md to a GitHub wiki (PR #3993) "

@sxa commented on this pull request.

I quite like having the reviews so I notice when changes are made, but I appreciate that's not a compelling reason. Since it's quite a formal process maybe there's some advantage to having it formally reviewed when changes are made. So I'll stay neutral and let two other people review this one ;-) Good shout on making sure we don't just delete the file and replacing it with a link to the new location though.

BTW there is one part of this file that I think has some formatting oddities

• if you find them while reading through the rendered output it would be good to correct them.

— Reply to this email directly, view it on GitHub (https://github.com/adoptium/temurin-build/pull/3993#pullrequestreview-2362801918) , or unsubscribe (https://github.com/notifications/unsubscribe-auth/AAWFCS4DVKXPVEWDQDHWTJLZ27GLFAVCNFSM6AAAAABPY5IHFKVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDGNRSHAYDCOJRHA) . You are receiving this because you are subscribed to this thread. Message ID: @.***> "

[gdams]

I think there is a way to keep wiki in sources, and so to make PRs mandatory for them, and still have wiki as read only view on them. Cant his be set up?

I guess the point I'm making is that in my opinion PRs shouldn't be mandatory, we shouldn't be adding hurdles to people who want to improve our docs. For what it's worth, Wikis do still have revision history so if we used meaningful updates this might be okay? https://github.com/adoptium/temurin-build/wiki/Temurin-Release-Guide/_history

[judovana]

Tahts a good point. To full-fill both - no PR for doc only, and have doc change part of the PR is hard one. I would still vote the second option. As the doc-only change can have very narrow and stright forward review. But it is narrow fight 49:51:( Good luck!

[sxa]

Tahts a good point. To full-fill both - no PR for doc only, and have doc change part of the PR is hard one. I would still vote the second option. As the doc-only change can have very narrow and stright forward review. But it is narrow fight 49:51:( Good luck!

Yeah same view as me then :-) Ultimately both are viable and as a "part of the release process" document I like it being under full change control but not enough to block this

The releasing doc is a bit special as it covers various areas of the project and quite often any changes aren't directly aligned with stuff in this repository as well so you can't necessarily put any code change and doc change into the same PR. And, of course, this is a doc which we frequently perform updates to for clarifications etc. independent of actual code changes to avoid any undue stress for people following the steps in here during the busy release cycles.

There may be a valid argument for using a wiki in the adoptium/temurin repository instead of in build since it's not just covering things in the build repo 🤷🏻

I agree, I'm watching the diffs too

As George says the pages still have change history, and I would strongly recommend that anyone updating this way uses the comment box at the bottom so there is a meaningful change log, similar to commit messages.

[gdams]

I can move the wiki to the adoptium/temurin repo if you'd prefer it to be located there?

[gdams]

I can move the wiki to the adoptium/temurin repo if you'd prefer it to be located there?

@sxa can you please confirm if you'd prefer I move the wiki to the temurin repo?

[sxa]

I can move the wiki to the adoptium/temurin repo if you'd prefer it to be located there?

@sxa can you please confirm if you'd prefer I move the wiki to the temurin repo?

My (slight) preference is still slightly to leave it as a file in the main repo, but if we're moving it in into a wiki I'd definitely prefer it to be put into the temurin repo alongside the checklists. Having said that I'm pretty neutral on all of it so it would be good to get others' opinions which might be stronger than mine ;-)

[karianna]

I'm good with moving this.

[adamfarley]

This document should always have regular reviews for readability, and I think having it in wiki form makes said reviews harder.

I recommend either:

• Keeping the document in a Github repo and reducing the number of reviews to 1. And/Or
• Having the wiki document be an "additional notes" document for gotchas, situational tips on best practices, etc.

[karianna]

@gdams will need a rebase.