Skip to content

feat: Add release.sh script and detect breaking changes #5366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Dec 15, 2022
+390 −16
Merged

feat: Add release.sh script and detect breaking changes #5366

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
19a39b4
feat: Add `release.sh` script and detect breaking changes
mafredri Dec 9, 2022
7d372f9
Update scripts/check_commit_metadata.sh
mafredri Dec 12, 2022
0f5883f
chore: Move release scripts to scripts/release folder
mafredri Dec 12, 2022
a5468e2
fix: Explicitly format compare URL like GitHub would
mafredri Dec 12, 2022
318be9a
fix: Remove no-op tagging
mafredri Dec 12, 2022
8e89727
Remove extra :
mafredri Dec 12, 2022
1cf1c84
Add compare to comparison link
mafredri Dec 12, 2022
3e6c295
Remove issourced check from error
mafredri Dec 12, 2022
c871cb7
Use gh pr list to reduce API requests
mafredri Dec 15, 2022
10f15fc
Fix usage comment
mafredri Dec 15, 2022
906a324
Fix value check
mafredri Dec 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: Move release scripts to scripts/release folder
  • Loading branch information
@mafredri
mafredri committed Dec 12, 2022
commit 0f5883f6d36e7df5c4fcb50467857b78d9f7dbe7
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ jobs:

- name: Publish release
run: |
./scripts/publish_release.sh \
./scripts/release/publish.sh \
${{ (github.event.inputs.dry_run || github.event.inputs.snapshot) && '--dry-run' }} \
./build/*_installer.exe \
./build/*.zip \
Expand Down
6 changes: 3 additions & 3 deletions scripts/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ mapfile -t versions < <(gh api -H "Accept: application/vnd.github+json" /repos/c
old_version=${versions[0]}

log "Checking commit metadata for changes since $old_version..."
# shellcheck source=scripts/check_commit_metadata.sh
source "$SCRIPT_DIR/check_commit_metadata.sh" "$old_version..$ref"
# shellcheck source=scripts/release/check_commit_metadata.sh
source "$SCRIPT_DIR/release/check_commit_metadata.sh" "$old_version..$ref"

mapfile -d . -t version_parts <<<"$old_version"
if [[ $minor == 1 ]] || [[ $COMMIT_METADATA_BREAKING == 1 ]]; then
Expand All @@ -93,7 +93,7 @@ new_version="${version_parts[0]}.${version_parts[1]}.${version_parts[2]}"
log "Old version: ${old_version}"
log "New version: ${new_version}"

release_notes="$(execrelative ./generate_release_notes.sh --old-version "$old_version" --new-version "$new_version" --ref "$ref")"
release_notes="$(execrelative ./release/generate_release_notes.sh --old-version "$old_version" --new-version "$new_version" --ref "$ref")"

echo
read -p "Preview release notes? (y/n) " -n 1 -r show_reply
Expand Down
2 changes: 1 addition & 1 deletion scripts/check_commit_metadata.sh → scripts/release/check_commit_metadata.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

set -euo pipefail
# shellcheck source=scripts/lib.sh
source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
source "$(dirname "${BASH_SOURCE[0]}")/../lib.sh"

range=${1:-}

Expand Down
6 changes: 3 additions & 3 deletions scripts/generate_release_notes.sh → scripts/release/generate_release_notes.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

set -euo pipefail
# shellcheck source=scripts/lib.sh
source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
source "$(dirname "${BASH_SOURCE[0]}")/../lib.sh"

old_version=
new_version=
Expand Down Expand Up @@ -58,8 +58,8 @@ if [[ -z $ref ]]; then
error "No ref specified"
fi

# shellcheck source=scripts/check_commit_metadata.sh
source "$SCRIPT_DIR/check_commit_metadata.sh" "${old_version}..${ref}"
# shellcheck source=scripts/release/check_commit_metadata.sh
source "$SCRIPT_DIR/release/check_commit_metadata.sh" "${old_version}..${ref}"

# Sort commits by title prefix, then by date, only return sha at the end.
mapfile -t commits < <(git log --no-merges --pretty=format:"%ct %h %s" "${old_version}..${ref}" | sort -k3,3 -k1,1n | cut -d' ' -f2)
Expand Down
8 changes: 4 additions & 4 deletions scripts/publish_release.sh → scripts/release/publish.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# pipeline to do the final publish step. If you want to create a release use:
# git tag -a -m "$ver" "$ver" && git push origin "$ver"
#
# Usage: ./publish_release.sh [--version 1.2.3] [--dry-run] path/to/asset1 path/to/asset2 ...
# Usage: ./publish.sh [--version 1.2.3] [--dry-run] path/to/asset1 path/to/asset2 ...
#
# The supplied images must already be pushed to the registry or this will fail.
# Also, the source images cannot be in a different registry than the target
Expand All @@ -27,7 +27,7 @@

set -euo pipefail
# shellcheck source=scripts/lib.sh
source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
source "$(dirname "${BASH_SOURCE[0]}")/../lib.sh"

if [[ "${CI:-}" == "" ]]; then
error "This script must be run in CI"
Expand Down Expand Up @@ -106,8 +106,8 @@ if [[ "$dry_run" == 1 ]]; then
new_ref="$(git rev-parse --short HEAD)"
fi

# shellcheck source=scripts/check_commit_metadata.sh
source "$SCRIPT_DIR/check_commit_metadata.sh" "$old_tag..$new_ref"
# shellcheck source=scripts/release/check_commit_metadata.sh
source "$SCRIPT_DIR/release/check_commit_metadata.sh" "$old_tag..$new_ref"

# Craft the release notes.
release_notes="$(execrelative ./generate_release_notes.sh --old-version "$old_tag" --new-version "$new_tag" --ref "$new_ref")"
Expand Down