Skip to content
cccskills
FreePublished on GitHub

fory-release

Prepare an Apache Fory release candidate by coordinating the version bump, immutable RC tag, JVM artifact staging, signed source archive, and ASF Subversion upload. It also drafts a verifiable vote email using the release outputs and required checks.

OriginalShow the original description

Prepare an Apache Fory release candidate from a clean release branch, including the version bump, RC tag, JVM staging, ASF source artifacts, SVN upload, and vote email. Use when creating or rerunning a Fory release candidate.

apache/fory4,576 stars(GitHub 4,576 + cccskills 0)

Run score Not tested

See how to install

Good for

  • Preparing a new Apache Fory release candidate
  • Resuming an interrupted Fory release workflow
  • Drafting a vote email after artifact checks

Files included (5)

  • SKILL.md11.2 KB
  • assets/vote-email.txt1.8 KB
  • references/nexus-staging.md2.8 KB
  • scripts/check_tag_workflows.py5.4 KB
  • scripts/find_discussion.py3.8 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Apache Fory Release

Use the repository release script for the release work. Do not manually reproduce its version-bump, JVM-publication, or source-build logic, and do not add unrelated test runs.

Required Inputs

Collect these values before starting:

  • release_version: final version without v or an RC suffix, such as 1.7.0.
  • rc: RC suffix, such as rc3.
  • previous_version: previous release tag version, such as 1.6.1.
  • Release discussion URL, if already known. If it is not supplied, find the exact release thread in the Fory development-list archive as described below.

Load release-manager details from .local/fory-release.env. If it does not exist, ask for the following values once, create the ignored local file, and continue. Never commit this file.

FORY_RELEASE_MANAGER_NAME="..."
FORY_RELEASE_APACHE_EMAIL="..."
FORY_RELEASE_GPG_FINGERPRINT="..."
FORY_DIST_DEV_WC="..."

Load the cached values and derive the release values:

repo_root="$(git rev-parse --show-toplevel)"
release_config="$repo_root/.local/fory-release.env"
test -f "$release_config"
. "$release_config"

release_branch="releases-${release_version}"
rc_tag="v${release_version}-${rc}"
dist_version="${release_version}"
release_manager_name="${FORY_RELEASE_MANAGER_NAME:?missing release manager name}"
apache_email="${FORY_RELEASE_APACHE_EMAIL:?missing Apache email}"
gpg_fingerprint="${FORY_RELEASE_GPG_FINGERPRINT:?missing GPG fingerprint}"
svn_wc="${FORY_DIST_DEV_WC:?missing ASF Subversion working-copy path}"

Use the same dist_version in Subversion and the vote email.

Find the release discussion

If the release discussion URL was not supplied, search the Fory development-list archive for the exact release version and a [DISCUSS] subject. Use the deterministic helper, which accepts exactly one root discussion thread:

discussion_url="$(
  python3 .agents/skills/fory-release/scripts/find_discussion.py \
    "$release_version"
)"

Open the resulting URL and verify that its subject and body discuss the exact release_version. If the automated search finds zero or multiple roots, use the archive UI to search the same exact version and [DISCUSS]; ask the release manager only if the result remains absent or ambiguous. When a URL is supplied, open and verify it instead of assuming it matches this release.

Release Workflow

1. Create a clean release branch

Run from the repository root. Clean means no staged, modified, or untracked files.

test -z "$(git status --porcelain)"
test "$(git remote get-url apache)" = "git@github.com:apache/fory.git"
git fetch apache main --tags
git switch -c "$release_branch" apache/main
test -z "$(git status --porcelain)"

For a new release branch, stop if the branch already exists or either cleanliness check fails. To resume an existing candidate, follow Release retries instead of recreating its branch or tag. Do not remove or hide user files to make the check pass.

2. Bump the version

python3 ci/release.py bump_version -version "$release_version" -l all
git diff --check
git status --short

Review the version diff. Use this command directly; do not substitute another version-bump workflow.

3. Commit the release version

git add -u
git commit -m "prepare release for ${release_version}"
test -z "$(git status --porcelain)"
release_commit="$(git rev-parse HEAD)"

Stage only the version changes produced by the release script.

4. Create and push the RC tag

Before creating a new RC tag, confirm that neither the local nor remote tag already exists. Never move, delete, or overwrite a published RC tag. Retrying a workflow for its existing tag does not create a new candidate; follow Release retries.

test -z "$(git tag --list "$rc_tag")"
test -z "$(git ls-remote --tags apache "refs/tags/${rc_tag}")"
test "$(git rev-parse HEAD)" = "$release_commit"
git tag "$rc_tag" && git push apache "$rc_tag"
test "$(git rev-parse "${rc_tag}^{commit}")" = "$release_commit"

The tag starts the ecosystem package-release workflows. Do not wait for them here: start JVM publication immediately so the remote workflows and JVM staging run in parallel. If a later step fails, diagnose it using Release retries before deciding whether the candidate needs to change.

5. Publish JVM artifacts

python3 ci/release.py publish_jvm

The command publishes from a temporary worktree at the committed HEAD and removes that worktree afterward. Record the distinct Java/Kotlin and Scala Nexus staging repository IDs from the output:

java_kotlin_staging_id="orgapachefory-..."
scala_staging_id="orgapachefory-..."
test -n "$java_kotlin_staging_id"
test -n "$scala_staging_id"
test "$java_kotlin_staging_id" != "$scala_staging_id"

After recording both IDs, read and follow Nexus staging closure. It contains the credential rules, authenticated state checks, /bulk/close request, HTTP 201 gate, close polling, failure inspection, and anonymous artifact checks. Do not close any repository ID that was not recorded from this publication. Keep both repositories closed during the vote; do not promote them until the vote passes.

6. Check the tag-triggered workflows

After JVM publication and Nexus closure, inspect the workflows that have been running since the tag was pushed. Filter by the tag rather than only by commit SHA so main-branch runs at the same commit are not mixed into the result. By default, wait for every tag-triggered run and require successful conclusions:

python3 .agents/skills/fory-release/scripts/check_tag_workflows.py \
  --repo apache/fory \
  --tag "$rc_tag" \
  --commit "$release_commit" \
  --watch

The helper re-queries by tag after waiting to catch later-created runs. A failed run requires diagnosis, not an automatic RC increment. For a transient failure, rerun only the failed jobs with gh run rerun <run-id> --repo apache/fory --failed, then run the helper again for the same tag and commit.

If the release manager explicitly waives workflow monitoring for a particular RC, run the same command with --allow-incomplete instead of --watch, and record the snapshot IDs, states, and reason. Do not cancel the remote workflows or report incomplete runs as successful.

7. Build the ASF source release

Start from the clean release branch and build the exact RC tag. The build must archive that tag without changing tracked files, creating commits, or moving Git refs. Benchmark-specific attribution belongs in benchmarks/LICENSE, alongside the benchmark sources excluded from the archive; do not rewrite the root LICENSE during packaging.

test -z "$(git status --porcelain)"
before_build="$(git rev-parse HEAD)"
test "$(git rev-parse "${rc_tag}^{commit}")" = "$release_commit"
python3 ci/release.py build -v "$release_version" --rc-tag "$rc_tag"
test "$(git rev-parse HEAD)" = "$before_build"
test -z "$(git status --porcelain)"
test -f "dist/apache-fory-${release_version}-src.tar.gz"
test -f "dist/apache-fory-${release_version}-src.tar.gz.asc"
test -f "dist/apache-fory-${release_version}-src.tar.gz.sha512"
test "$(gzip -dc "dist/apache-fory-${release_version}-src.tar.gz" | git get-tar-commit-id)" = "$release_commit"

The build command verifies the generated PGP signature and SHA-512 checksum. The archive must match a direct git archive of the RC tag, including its embedded commit ID and unmodified root LICENSE.

8. Commit the source release to ASF Subversion

Use a clean, updated working copy of the ASF development distribution repository.

test -d "$svn_wc/.svn" || svn checkout https://dist.apache.org/repos/dist/dev/fory "$svn_wc"
svn update "$svn_wc"
mkdir -p "$svn_wc/$dist_version"
cp dist/* "$svn_wc/$dist_version/"
svn add --force "$svn_wc/$dist_version"
svn status "$svn_wc/$dist_version"
svn commit "$svn_wc/$dist_version" -m "Prepare Apache Fory ${rc_tag}"
test -z "$(svn status "$svn_wc/$dist_version")"
svn log -l 1 "$svn_wc/$dist_version"
svn ls "https://dist.apache.org/repos/dist/dev/fory/${dist_version}/"

Inspect svn status before committing. The upload is complete only after svn commit returns a revision and the remote svn ls shows the three release files; local A status alone is not an upload.

9. Draft the vote email

Read the vote email template and produce a complete, copyable email. Replace every placeholder from verified output, confirm that no ${...} placeholder remains, use an explicit UTC deadline at least 72 hours after sending, and do not send the email unless requested.

Before sending, verify the tag and commit, all URLs, both closed Maven staging repositories, the remote Subversion files, PGP fingerprint, and UTC deadline against the actual release outputs.

Release retries

An RC identifies the release content under review, not a CI attempt. Inspect the failed step and its logs before deciding how to recover. Network timeouts, dependency-download failures, runner failures, and interrupted status checks do not by themselves invalidate an unchanged candidate.

Without a substantive release change, keep the same release commit and RC tag and resume only the failed or incomplete steps. Preserve verified Maven staging repositories and source artifacts; do not rebuild or republish successful artifacts merely because an unrelated CI job failed. Before retrying a push, upload, Nexus action, or SVN commit, inspect remote state because an interrupted request may already have succeeded. Use the Nexus reference's --verify-only path for repositories that are already closed.

Create a higher RC only when a substantive fix changes the release content, such as source, dependencies, build inputs, or packaging. Commit the actual fix before tagging the replacement; do not create an empty commit or a second RC at the same unchanged release commit just to retry infrastructure. Keep the previous tag immutable and verify the replacement artifacts through the release workflow. An unresolved code or artifact defect still blocks the vote.

Stop Conditions

Before creating a new tag, stop if the Git tree is dirty, the tag already exists, or its target would differ from the release commit. A failed JVM publication, workflow, artifact check, or SVN operation pauses the dependent step until it is diagnosed and recovered under Release retries; failure alone does not require a higher RC. Before sending the vote, require both staging repositories to be closed and public, the Subversion commit to be remotely visible, and the tag workflows to be successful unless the release manager explicitly waived monitoring.

References

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Improve Apache Fory serialization and deserialization performance across its language implementations. The skill profiles bottlenecks, compares paired benchmarks against a baseline, and guides focused changes while checking correctness and cross-language compatibility.

  • Finding serialization or deserialization bottlenecks
  • Investigating a performance regression against a reference commit
  • Diagnosing flamegraphs or performance CI failures
apache/fory4.6KUpdated Oct 27, 2026

Update Apache Fory version references across language packages, integration tests, examples, and source documentation. This skill distinguishes released versions from next development versions, applies the release helper, and checks for stale or misplaced version strings.

  • Preparing versions for a Fory release
  • Moving package metadata to the next development version
  • Updating install docs to a released version
apache/fory4.6KUpdated Oct 27, 2026

See all skills by apache

Report a problem with this skill