Skip to content

[release] Add release workflows and documentation - #8948

Open
JingsongLi wants to merge 4 commits into
apache:masterfrom
JingsongLi:codex/release-docs
Open

[release] Add release workflows and documentation#8948
JingsongLi wants to merge 4 commits into
apache:masterfrom
JingsongLi:codex/release-docs

Conversation

@JingsongLi

@JingsongLi JingsongLi commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

What changed

  • add a tag-triggered release orchestrator under .github/workflows
  • package Java artifacts in separate JDK 8, JDK 11, and JDK 17 jobs
  • build PyPaimon sdist/wheel artifacts and publish RCs to TestPyPI or final releases to PyPI
  • add release-manager and release-candidate verification guides
  • expose both guides in the Project documentation sidebar

Release workflow

  • release.yml coordinates Java packaging, PyPaimon packaging, and gated publication
  • release-java.yml builds unsigned Java packages with -Dgpg.skip=true and records package manifests and SHA-512 checksums
  • release-python.yml validates package versions, builds the sdist and universal wheel, and checks legal files
  • release-python-publish.yml publishes RC tags to TestPyPI and final tags to PyPI
  • Java GPG signing and Nexus staging remain on the RM machine using the existing JDK-specific scripts
  • ASF source archives remain RM-created, signed, and uploaded from the exact RC tag

The Java workflows do not receive GPG keys or Nexus credentials. Only the Python publishing job uses the protected release environment; its required secrets are documented in the release guide.

Validation

  • actionlint 1.7.12 on all four new workflows
  • Bash syntax validation for workflow run steps and local staging scripts
  • ./node_modules/.bin/docusaurus build
  • local PyPaimon sdist/wheel build
  • python -m twine check
  • archive LICENSE/NOTICE content checks
  • git diff --check

The Docusaurus build succeeds. It continues to report the repository's existing global broken-link warning for /docs/master/concepts/overview; the new release-document routes and cross-links are generated successfully.

@JingsongLi JingsongLi changed the title [docs] Add release and verification guides [release] Add release workflows and documentation Jul 30, 2026
@JingsongLi
JingsongLi marked this pull request as ready for review July 30, 2026 15:05
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.

1 participant