Skip to content

chore(docs): parameterize RC version in RELEASE.md and add archive prefix - #625

Merged
martin-g merged 1 commit into
apache:mainfrom
iemejia:docs-release-rc-version
Aug 10, 2026
Merged

chore(docs): parameterize RC version in RELEASE.md and add archive prefix#625
martin-g merged 1 commit into
apache:mainfrom
iemejia:docs-release-rc-version

Conversation

@iemejia

@iemejia iemejia commented Aug 10, 2026

Copy link
Copy Markdown
Member

What

Improve the release instructions in RELEASE.md:

  • Introduce an AVRO_RC_VERSION variable (e.g. RC0) and use it for the git tag, tarball name, and SVN upload steps.
  • Add --prefix=apache-avro-rs-$AVRO_RS_VERSION-$AVRO_RC_VERSION/ to git archive so the tarball extracts into a top-level directory instead of dumping files into the current directory.
  • Quote variable expansions and guard cd calls, per shellcheck (SC2086, SC2164).

Why

The previous git archive command produced a tarball without a prefix directory, and the RC identifier was hardcoded in several places.

Introduce AVRO_RC_VERSION variable, use it for the tag, tarball name,
and git archive --prefix so the tarball extracts into a top-level
directory. Quote variable expansions and guard cd calls per shellcheck.
@Kriskras99

Copy link
Copy Markdown
Contributor

Can I also suggest (not for this PR) to publish the release candidates on crates.io?
This will make it significantly easier for users to test the code.

@martin-g
martin-g merged commit d799f53 into apache:main Aug 10, 2026
16 checks passed
@martin-g martin-g changed the title docs: parameterize RC version in RELEASE.md and add archive prefix chore(docs): parameterize RC version in RELEASE.md and add archive prefix Aug 10, 2026
@martin-g martin-g added this to the 0.23.0 milestone Aug 10, 2026
@martin-g

Copy link
Copy Markdown
Member

Can I also suggest (not for this PR) to publish the release candidates on crates.io?

Do other projects publish RCs ? Do you have some examples ?

@Kriskras99

Copy link
Copy Markdown
Contributor

Yes, and Cargo has full support for release candidates (it won't auto update to them).
rand is one example.

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.

3 participants