Skip to content

docs: update RELEASE.md examples for 8.0.0-M1#15619

Open
jamesfredley wants to merge 1 commit into8.0.xfrom
docs/release-md-update-for-8.0.0-m1
Open

docs: update RELEASE.md examples for 8.0.0-M1#15619
jamesfredley wants to merge 1 commit into8.0.xfrom
docs/release-md-update-for-8.0.0-m1

Conversation

@jamesfredley
Copy link
Copy Markdown
Contributor

Summary

Update RELEASE.md on 8.0.x so its worked examples target the upcoming v8.0.0-M1 release. The file was previously byte-for-byte identical to the 7.0.x copy and still referenced v7.0.0-M4 and the 7.0.x branch everywhere, which is misleading for anyone preparing the first 8.0.x milestone.

Changes

Version examples updated for 8.0.0-M1

  • ## 1. Staging example tag and target branch
  • ## 2. Verifying Artifacts are Authentic verify.sh example
  • Manual Verification: Jar file Signature Verification verify-jar-artifacts.sh example
  • Update ASF Reporter example release name (CORE-8.0.0-M1)
  • Appendix: Verification from a Container substitution hint now includes v8.0.0-M1 as a concrete example

Small defects fixed in the same sections

  • Manual Verification: Reproducible Jar Files referenced a non-existent script very-reproducible.sh. Replaced with the actual verify-reproducible.sh.
  • The same section's manual gradle-bootstrap example (gradle -p gradle-bootstrap) did not match what verify.sh actually does. Updated to cd gradle-bootstrap && gradle, which mirrors the script.
  • Appendix: Verification from a Container had an unbalanced backtick and missing > in `<git-tag-of-release`. Closed the placeholder and added a v8.0.0-M1 example.
  • Update ASF Reporter had a small typo (with be -> will be) on the line being version-bumped.

Verification done locally

The container verification flow itself (docker build -f etc/bin/Dockerfile . && docker run ... verify.sh v8.0.0-M1 .) cannot complete end-to-end until the v8.0.0-M1 tag is pushed and release.yml stages artifacts to https://dist.apache.org/repos/dist/dev/grails/core/8.0.0-M1/. What I am verifying locally before approving this PR for the release process is the verification environment on the current 8.0.x Dockerfile (JDK 21.0.7 Liberica, all required tooling on PATH, gradle-bootstrap runs cleanly inside the container against the mounted source tree). Results will be posted as a follow-up comment.

Out of scope

  • No script changes. etc/bin/verify*.sh are version-agnostic (tag is passed as $1) and need no edits for 8.0.0-M1.
  • No Dockerfile changes. etc/bin/Dockerfile already pins bellsoft/liberica-openjdk-debian:21.0.7, matching .sdkmanrc (java=21.0.7-librca) and release.yml (JAVA_DISTRIBUTION: liberica).

The 8.0.x branch's RELEASE.md was identical to 7.0.x and still
referenced v7.0.0-M4 / 7.0.x in every worked example. Update the
version examples and target branch to v8.0.0-M1 / 8.0.x so the
document is correct for the upcoming first 8.0.x milestone release.

Also fix a few small defects discovered while reviewing the same
sections:

- Replace the `very-reproducible.sh` typo with the actual filename
  `verify-reproducible.sh`.
- Adjust the manual gradle-bootstrap example to match what
  `verify.sh` actually does (cd into gradle-bootstrap, then run
  gradle).
- Close the unbalanced backtick around `<git-tag-of-release>` in
  the "Appendix: Verification from a Container" section and add
  `v8.0.0-M1` as a concrete substitution example.
- Fix `with be` -> `will be` typo in the ASF Reporter example
  (touched the same line as the version bump).

Assisted-by: claude-code:claude-opus-4-7
Copilot AI review requested due to automatic review settings May 2, 2026 12:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@testlens-app
Copy link
Copy Markdown

testlens-app Bot commented May 2, 2026

✅ All tests passed ✅

🏷️ Commit: 7ec72cf
▶️ Tests: 16933 executed
⚪️ Checks: 39/39 completed


Learn more about TestLens at testlens.app.

Copy link
Copy Markdown
Contributor

@jdaugherty jdaugherty left a comment

Choose a reason for hiding this comment

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

I don't think we should be updating release.md every major version. the document is meant to be examples - its not supposed to track our versions.

Comment thread RELEASE.md
* On the draft new release screen, we execute the following steps:
* The tag will have the prefix 'v', so for our release it would be 'v7.0.0-M4'
* The "Target" will be the branch we build out of (this case it's the default, 7.0.x)
* The tag will have the prefix 'v', so for our release it would be 'v8.0.0-M1'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why even bother changing this? The point of this is to just give an example release tag, not keep
it in sync with our version

Comment thread RELEASE.md
After all jar files are verified to be signed by a valid Grails key, we need to build a local copy to ensure the file was built with the right code base. The `verify-reproducible.sh` script handles this check, but if the bootstrap needs to be manually bootstrapped, perform the following step from inside the downloaded source distribution:

gradle -p gradle-bootstrap
cd gradle-bootstrap && gradle
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why are you changing this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants