mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-07 20:32:59 +00:00
5349e8b1db
This PR changes the release process. Some parts are more complex, and other parts I've simplified. ## Simplifications * Combined `Create Release Commit` and `Create Python Release Commit` into a single workflow. By default, it does a release of all packages, but you can still choose to make just a Python or just Node/Rust release through the arguments. This will make it rarer that we create a Node release but forget about Python or vice-versa. * Releases are automatically generated once a tag is pushed. This eliminates the manual step of creating the release. * Release notes are automatically generated and changes are categorized based on the PR labels. * Removed the use of `LANCEDB_RELEASE_TOKEN` in favor of just using `GITHUB_TOKEN` where it wasn't necessary. In the one place it is necessary, I left a comment as to why it is. * Reused the version in `python/Cargo.toml` so we don't have two different versions in Python LanceDB. ## New changes * We now can create `preview` / `beta` releases. By default `Create Release Commit` will create a preview release, but you can select a "stable" release type and it will create a full stable release. * For Python, pre-releases go to fury.io instead of PyPI * `bump2version` was deprecated, so upgraded to `bump-my-version`. This also seems to better support semantic versioning with pre-releases. * `ci` changes will now be shown in the changelog, allowing changes like this to be visible to users. `chore` is still hidden. ## Versioning **NOTE**: unlike how it is in lance repo right now, the version in main is the last one released, including beta versions. --------- Co-authored-by: Lance Release <lance-dev@lancedb.com> Co-authored-by: Weston Pace <weston.pace@gmail.com>
50 lines
1.8 KiB
Bash
50 lines
1.8 KiB
Bash
set -e
|
|
|
|
RELEASE_TYPE=${1:-"stable"}
|
|
BUMP_MINOR=${2:-false}
|
|
TAG_PREFIX=${3:-"v"} # Such as "python-v"
|
|
HEAD_SHA=${4:-$(git rev-parse HEAD)}
|
|
|
|
readonly SELF_DIR=$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
|
|
|
|
PREV_TAG=$(git tag --sort='version:refname' | grep ^$TAG_PREFIX | python $SELF_DIR/semver_sort.py $TAG_PREFIX | tail -n 1)
|
|
echo "Found previous tag $PREV_TAG"
|
|
|
|
# Initially, we don't want to tag if we are doing stable, because we will bump
|
|
# again later. See comment at end for why.
|
|
if [[ "$RELEASE_TYPE" == 'stable' ]]; then
|
|
BUMP_ARGS="--no-tag"
|
|
fi
|
|
|
|
# If last is stable and not bumping minor
|
|
if [[ $PREV_TAG != *beta* ]]; then
|
|
if [[ "$BUMP_MINOR" != "false" ]]; then
|
|
# X.Y.Z -> X.(Y+1).0-beta.0
|
|
bump-my-version bump -vv $BUMP_ARGS minor
|
|
else
|
|
# X.Y.Z -> X.Y.(Z+1)-beta.0
|
|
bump-my-version bump -vv $BUMP_ARGS patch
|
|
fi
|
|
else
|
|
if [[ "$BUMP_MINOR" != "false" ]]; then
|
|
# X.Y.Z-beta.N -> X.(Y+1).0-beta.0
|
|
bump-my-version bump -vv $BUMP_ARGS minor
|
|
else
|
|
# X.Y.Z-beta.N -> X.Y.Z-beta.(N+1)
|
|
bump-my-version bump -vv $BUMP_ARGS pre_n
|
|
fi
|
|
fi
|
|
|
|
# The above bump will always bump to a pre-release version. If we are releasing
|
|
# a stable version, bump the pre-release level ("pre_l") to make it stable.
|
|
if [[ $RELEASE_TYPE == 'stable' ]]; then
|
|
# X.Y.Z-beta.N -> X.Y.Z
|
|
bump-my-version bump -vv pre_l
|
|
fi
|
|
|
|
# Validate that we have incremented version appropriately for breaking changes
|
|
LAST_STABLE_RELEASE=$(git tag --sort='version:refname' | grep ^$TAG_PREFIX | grep -v beta | python $SELF_DIR/semver_sort.py $TAG_PREFIX | tail -n 1)
|
|
LAST_STABLE_VERSION=$(echo $LAST_STABLE_RELEASE | sed "s/^$TAG_PREFIX//")
|
|
NEW_VERSION=$(git describe --tags --exact-match HEAD | sed "s/^$TAG_PREFIX//")
|
|
python $SELF_DIR/check_breaking_changes.py $LAST_STABLE_RELEASE $HEAD_SHA $LAST_STABLE_VERSION $NEW_VERSION
|