Skip to content

Commit

Permalink
ci: use cargo-semver-checks to detect semver violations
Browse files Browse the repository at this point in the history
  • Loading branch information
weihanglo committed Jul 24, 2023
1 parent 7c82ff2 commit 86b7e6a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 46 deletions.
8 changes: 7 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,14 @@ jobs:
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0 # make `git diff` work
fetch-depth: 0
- run: rustup update stable && rustup default stable
- name: Install cargo-semver-checks
run: |
mkdir installed-bins
curl -Lf https://github.com/obi1kenobi/cargo-semver-checks/releases/download/v0.22.1/cargo-semver-checks-x86_64-unknown-linux-gnu.tar.gz \
| tar -xz --directory=./installed-bins
echo `pwd`/installed-bins >> $GITHUB_PATH
- run: ci/validate-version-bump.sh

test:
Expand Down
48 changes: 3 additions & 45 deletions ci/validate-version-bump.sh
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
#!/bin/bash
# This script checks if a crate needs a version bump.
#
# At the time of writing, it doesn't check what kind of bump is required.
# In the future, we could take SemVer compatibliity into account, like
# integrating `cargo-semver-checks` of else
# Use `cargo-semver-checks` to detect if a crate needs a version bump due to
# SemVer violation.
#
# Inputs:
# BASE_SHA The commit SHA of the branch where the PR wants to merge into.
Expand All @@ -19,43 +16,4 @@ head_sha=$(git rev-parse "${HEAD_SHA:-HEAD}")
echo "Base branch is $base_sha"
echo "Current head is $head_sha"

# Gets crate names of members that has been changed from $bash_sha to $head_sha.
changed_crates=$(
git diff --name-only "$base_sha" "$head_sha" -- crates/ credential/ benches/ \
| cut -d'/' -f2 \
| sort -u
)

if [ -z "$changed_crates" ]
then
echo "No file changed in member crates."
exit 0
fi

# Checks publish status for only crates with code changes.
publish_status_table=$(
echo "$changed_crates" \
| xargs printf -- '--package %s\n' \
| xargs cargo unpublished
)

# "yes" -> code changed but no version difference -> need a bump
# Prints 2nd column (sep by space), which is the name of the crate.
crates_need_bump=$(
echo "$publish_status_table" \
| { grep '| yes ' || true; } \
| awk '{print $2}'
)

if [ -z "$crates_need_bump" ]
then
echo "No version bump needed for member crates."
exit 0
fi

echo "Detected changes in these crates but no version bump found:"
echo "$crates_need_bump"
echo
echo "Please bump at least one patch version for each corresponding Cargo.toml:"
echo 'Run "cargo unpublished" to read the publish status table for details.'
exit 1
cargo semver-checks --workspace --baseline-rev "$base_sha"

0 comments on commit 86b7e6a

Please sign in to comment.