Skip to content

Update release review instructions - #480

Open
omribz156 wants to merge 2 commits into
apache:mainfrom
omribz156:codex/logging-release-review-docs
Open

Update release review instructions#480
omribz156 wants to merge 2 commits into
apache:mainfrom
omribz156:codex/logging-release-review-docs

Conversation

@omribz156

Copy link
Copy Markdown

Summary:

  • Remove the stale manual Log4j integration-test.yaml release-review step and call out release-branch CI instead.
  • Set CI=false in the local Linux/macOS reproducibility verification command.
  • Update post-vote git instructions to push branches and open PRs instead of merging directly to protected branches.
  • Mention Log4j site-related pom.xml version properties alongside the existing site-project.version note.

Fixes #479

Verification:

  • git diff --check (passes; local checkout reports the usual LF-to-CRLF warnings)
  • Static search confirmed the stale integration-test.yaml reference is gone and the new PR/reproducibility instructions are present

This was implemented with Codex assistance, with the final diff reviewed before posting.

Comment on lines +224 to +230
. Create a branch from `main-site-pro`, merge the `rel/7.8.0` tag (**not** the `release/7.8.0` branch!), and push it
+
[source,bash]
----
git checkout main-site-pro
git rebase origin/main-site-pro # Sync with the remote repository
git merge rel/7.8.0 # Pull changes up to the newly created tag
git push origin main-site-pro
git checkout -B publish-site/7.8.0 origin/main-site-pro
git merge rel/7.8.0 # Pull changes up to the newly created tag
git push -u origin publish-site/7.8.0

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@ppkarwasz, I think we should truncate and bootstrap main-site-pro from rel/7.8.0, instead of merging rel/7.8.0 to the current state of main-site-pro, since the latter results in an unknown state. WDYT?

FWIW, I don't know what "truncate and bootstrap" exactly translate to, but we can figure that detail out. The point is, after this operation main-site-pro should be identical to rel/7.8.0.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We can use:

git push --force-with-lease origin rel/7.8.0:main-site-pro

with some exceptions for LTS releases. For an LTS release you need to:

  1. First cherry-pick the changelog entry to the “main” branch.
  2. Then cherry-pick the same commit to main-site-pro.

Basically we are happy to sync the website with the code during a release (and remove all documentation changes done since the previous one, since those changes should already be present in the main branch). For LTS releases we only want to cherry-pick the changelog.

Comment thread src/site/antora/modules/ROOT/pages/release-instructions-project.adoc Outdated
Comment thread src/site/antora/modules/ROOT/pages/release-instructions-project.adoc Outdated
[source,bash]
----
git add .
git commit -S -a -m 'Prepare to release `7.8.0`'

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Commit signatures are not needed anymore:

Suggested change
git commit -a -m 'Prepare to release `7.8.0`'

====
Shared instructions hardcode the following constants:

Project ID::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Release branch::
`main`
Project ID::

The ASF infrastructure treats ``rel/``-prefixed git tags special and ensures they are immutable for provenance reasons.
====
. Merge the `rel/7.8.0` tag (**not** the `release/7.8.0` branch!) to `main`
. Create a branch from `main`, merge the `rel/7.8.0` tag (**not** the `release/7.8.0` branch!), and create a PR from that

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
. Create a branch from `main`, merge the `rel/7.8.0` tag (**not** the `release/7.8.0` branch!), and create a PR from that
. Create a branch from `main`, and merge the `rel/7.8.0` tag (**not** the `release/7.8.0` branch!) onto it:

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.

Project release review instructions are out-of-date

3 participants