Skip to content

Update release review instructions #480

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.

Sign up for GitHub

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

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

Update release review instructions #480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
263efa3
Update release review instructions
omribz156 May 16, 2026
ec44eef
docs: address release review feedback
omribz156 Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions src/site/antora/modules/ROOT/pages/release-instructions-project.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ git checkout -B release/7.8.0 origin/main
====
If your project refers to its own version in the site sources, those need to be updated too.
For instance, `site-project.version` needs to be updated for `logging-parent`.
Log4j also has site-related version properties in `pom.xml` that need to be updated.
====
.. Release the changelog:
+
Expand Down Expand Up @@ -99,13 +100,6 @@ If not, commit the necessary fixes, push, and repeat.
Once the release is staged, the Release Manager should:

. Follow the xref:release-review-instructions.adoc[] to verify the integrity of the release.
. Some projects have additional integration tests that need to run on the release candidate artifacts:

`logging-log4j2`::
+
Run the
https://github.com/apache/logging-log4j-samples/actions/workflows/integration-test.yaml[integration-test.yaml]
workflow using the appropriate version number and URL of the _Staging Repository_ as parameters.

[#vote-release]
== Vote the release
Expand Down Expand Up @@ -154,16 +148,22 @@ git push origin rel/7.8.0
====
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

@vy vy Aug 2, 2026

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:

+
[source,bash]
----
git checkout main
git rebase origin/main # Sync with the remote repository
git merge rel/7.8.0 # Pull changes up to the newly created tag
git checkout -B post-release/7.8.0 origin/main
git merge rel/7.8.0 # Pull changes up to the newly created tag
----
. Set the revision property to the next development version (e.g., `7.9.0-SNAPSHOT`) in `pom.xml`
. Commit changes and push the `main` branch
. Commit changes and push the branch
+
[source,bash]
----
git push -u origin post-release/7.8.0
----
+
. Open a pull request from `post-release/7.8.0` to `main`
. Delete the local and remote copies of the `release/7.8.0` branch
+
[source,bash]
Expand Down Expand Up @@ -220,16 +220,17 @@ svn commit -m 'Remove `{project-id}` version `7.8.0` files released'
[#publish-release-website]
== Publish the release website

. Merge the `rel/7.8.0` tag (**not** the `release/7.8.0` branch!) to `main-site-pro` and push it
. 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
Comment on lines +223 to +229

@vy vy May 18, 2026

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.

@ppkarwasz ppkarwasz Aug 13, 2026

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.

----
+
. Open a pull request from `publish-site/7.8.0` to `main-site-pro`
+
.If there is no `main-site-pro` branch yet
[%collapsible]
====
Expand Down
1 change: 1 addition & 0 deletions ...site/antora/modules/ROOT/partials/release-review-instructions/linux-verify.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.

[source,bash]
----
export CI=false
sh mvnw verify \
-Prelease artifact:compare \ #<1>
-Dreference.repo=https://repository.apache.org/... #<2>
Expand Down