Skip to content

Migrate Antora version update to GitHub [DI-719][DI-674]#2251

Open
nishaatr wants to merge 8 commits into
mainfrom
DI-719-migrate-antora-1
Open

Migrate Antora version update to GitHub [DI-719][DI-674]#2251
nishaatr wants to merge 8 commits into
mainfrom
DI-719-migrate-antora-1

Conversation

@nishaatr

@nishaatr nishaatr commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Details

Adds scripts and workflows to update Hazelcast antora.yml version updates:

Type Info
MAJOR/MINOR 1. updates main branch versions to the current hazelcast-mono@master POM version
2. updates release branch to the current release.
PATCH/BETA Updates release branch version with the current release version.
V/BRANCH Creates the v/branch from the release branch during the promote phase. This must happen during promote because v/branch makes the Docs go-live.

Additional fix

Release 5.6.0 - remove SNAPSHOT from verion: in hz-docs (DI-674)

Updates below fields which were previously ignored by Release Pipeline

minor-version: '5.9-SNAPSHOT'
version: '5.9-SNAPSHOT'

Testing

Tested in sandbox.

  1. Test release branches were created via https://github.com/hazelcast/hazelcast-pipeline-library/pull/362
  2. ReleaseInfo generated via Centralized release info [DI-719][DI-835] mono-actions#26
  3. Workflows (package and promote) triggered manually

Following are the merged PRs by release version

Version/branch Resulting PR
MAJOR/MINOR (5.8.0)
main Pull Request #68
5.8.0 Pull Request #69
v/5.8 Repository Tree
BETA (5.9.0-BETA-1)
main NOT updated
5.9.0-BETA-1 Pull Request #72
v/5.9-BETA-1 Repository Tree
PATCH (main skipped)
v/5.8 (5.8.1) Pull Request #70
v/5.8 (5.8.2) Pull Request #71
v/5.7 (5.7.6) Pull Request #73

Pre merge

  • Replace all occurrences of DI-719-migrate-antora-1 to main

Fixes: DI-719, DI-674

@github-actions

github-actions Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

@nishaatr nishaatr changed the title Di 719 migrate antora 1 Migrate Antora version update to GitHub [DI-719][DI-835][DI-674] Jul 12, 2026
@nishaatr nishaatr changed the title Migrate Antora version update to GitHub [DI-719][DI-835][DI-674] Migrate Antora version update to GitHub [DI-719][DI-674] Jul 12, 2026
@nishaatr
nishaatr force-pushed the DI-719-migrate-antora-1 branch from 39888c9 to 1488e02 Compare July 12, 2026 12:23
@nishaatr
nishaatr marked this pull request as ready for review July 12, 2026 13:01
@nishaatr
nishaatr requested a review from a team as a code owner July 12, 2026 13:01
@JackPGreen

Copy link
Copy Markdown
Contributor

If were adding Python to CI, we should continue also adding https://github.com/hazelcast/rel-scripts/blob/master/.github/workflows/validate-python.yml

Comment thread .github/workflows/release-pr-builder.yml Outdated
Comment thread .github/workflows/release-pr-builder.yml
Comment thread .github/workflows/release-pr-builder.yml Outdated
jobs:
test:
# Ignore automated release PR branches
if: ${{ !startsWith(github.head_ref, 'update_antora_') }}

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.

Do we also need to filter this out for the other validations, e.g.

pull_request_target:
branches: [main, 'v/*']

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

added v/*
8aeaf6e

actually, I added 'update_antora_' check simply because PR builder started running for release PR in sandbox even though the auto generated release PRs didn't update any scripts and if was present. May be because my changes are still in my branch but not sure. So I removed it from the other two docs PR builder but forgot to clean-up here

But now I am thinking should keep the if check + branches: [main, 'v/*'] as makes sense?

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.

I think my concern was not about maintenance branches and more about this special branch triggering actions on other workflows.

@nishaatr nishaatr Jul 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes need to I think. Kind of thought of this before

I first looked at maven-pr-builder.yaml and then checked other PR builder and didn't see any exclusions e.g. in deploy-preview.yml and kind of thought no need.

I will exclude in these:

build-site.yml
deploy-preview.yml

the others don't think need exclusion

I will revert 8aeaf6e as should not really trigger for v/branch

run-name: ${{ github.workflow }} (`${{ inputs.VERSION }}`@${{ inputs.ENVIRONMENT }})

on:
workflow_dispatch:

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.

Doesn't have a comment, but promote does.

Comment thread .github/workflows/package.yml
Comment on lines +27 to +33
prepare:
runs-on: ubuntu-slim
steps:
- name: Logging distinct ID (${{ inputs.distinct_id }})
run: echo "${DISTINCT_ID}"
env:
DISTINCT_ID: ${{ inputs.distinct_id }}

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.

Might as well add as a step in package to avoid starting a runner just to print the message and burning credits.

Comment thread .github/workflows/package.yml Outdated
Comment thread .github/workflows/promote.yml Outdated
Comment thread .github/workflows/promote.yml Outdated
Comment thread .github/scripts/antora_updater.py
nishaatr and others added 6 commits July 15, 2026 11:24
Co-authored-by: Jack Green <jack.green@hazelcast.com>
Co-authored-by: Jack Green <jack.green@hazelcast.com>
Co-authored-by: Jack Green <jack.green@hazelcast.com>
Co-authored-by: Jack Green <jack.green@hazelcast.com>
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.

2 participants