Jefffrey commented on code in PR #12188: URL: https://github.com/apache/arrow-rs/pull/12188#discussion_r4538849620
########## dev/release/README.md: ########## @@ -99,11 +123,6 @@ create a release candidate using the following steps. Note you need to be a committer to run these scripts as they upload to the apache `svn` distribution servers. -Install HawkEye 7.0.0 (`cargo install hawkeye --version 7.0.0 --locked`) Review Comment: moved to setup section above; i removed the detail too since this is meant to be a doc explaining release process, whilst this check is already part of CI anyway (so feels weird to explain that here) ########## dev/release/README.md: ########## @@ -197,11 +216,6 @@ standards. An Arrow committer can publish this crate after an official project release has been made to crates.io using the following instructions. -Follow [these Review Comment: moved above ########## dev/release/README.md: ########## @@ -50,25 +71,28 @@ git checkout -b <RELEASE_BRANCH> # Update versions. sed -i '' -e 's/14.0.0/39.0.0/g' `find . -name 'Cargo.toml' -or -name '*.md' | grep -v CHANGELOG.md | grep -v CHANGELOG-old.md | grep -v README.md` cargo check # update Cargo.lock with new versions -git commit -a -m 'Update version' + +# OPTIONAL: for non-major version updates, sanity check there are no semver violations +# https://github.com/obi1kenobi/cargo-semver-checks +cargo semver-checks --baseline-version <PREVIOUS_VERSION> Review Comment: technically dont strongly need this as https://github.com/apache/arrow-rs/pull/11949 exists, but this is just a reference for myself and its optional ########## .rat-excludes: ########## @@ -0,0 +1,3 @@ +# TODO: fill this in Review Comment: placeholder file to remind me this needs to be updated when we want to use ATR ########## dev/release/README.md: ########## @@ -22,6 +25,26 @@ Otherwise the new minor version incremented (e.g. `9.0.2` to `9.1.0`). # Release Mechanics +## Prerequisites Review Comment: make it clear upfront what needs to be installed/setup ########## dev/release/README.md: ########## @@ -237,3 +251,47 @@ Rust Arrow Crates: (cd parquet_derive && cargo publish) (cd arrow-integration-test && cargo publish) ``` + +## Fish version Review Comment: this is just for my personal reference; bit lazy so i want easy fish commands i can copy/paste into my terminal ########## dev/release/README.md: ########## @@ -50,25 +71,28 @@ git checkout -b <RELEASE_BRANCH> # Update versions. sed -i '' -e 's/14.0.0/39.0.0/g' `find . -name 'Cargo.toml' -or -name '*.md' | grep -v CHANGELOG.md | grep -v CHANGELOG-old.md | grep -v README.md` cargo check # update Cargo.lock with new versions -git commit -a -m 'Update version' + +# OPTIONAL: for non-major version updates, sanity check there are no semver violations +# https://github.com/obi1kenobi/cargo-semver-checks +cargo semver-checks --baseline-version <PREVIOUS_VERSION> # Assuming remote name is apache; if named differently ensure this is changed, # since we need the tags from the GitHub repository git fetch apache --tags -# ensure your github token is available +# Used by git-cliff to retrieve PR information from GitHub API export GITHUB_TOKEN=<TOKEN> # e.g. TAG=60.0.0; this is just used to format the CHANGELOG, so tag doesn't # need to exist yet, and don't put an RC tag either -# (we are excluding our above version bump commit from the changelog) -git-cliff --tag <TAG> --unreleased --output CHANGELOG.md --skip-commit $(git rev-parse HEAD) +# Replace 59.3.0 with previous tag (on the same branch) +git-cliff '59.3.0..' --tag <TAG> --output CHANGELOG.md Review Comment: changed command here: - we dont skip commit as i removed step above to commit the version update; we'll just do version update & changelog in same commit for simplicity - dont use `--unreleased` as that caused issues for me on a non-default branch (when backporting); instead rely on explicit git range of which commits we are releasing (all since latest tag on current branch) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
