Skip to content
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

Add release-patch script #1554

Merged
merged 10 commits into from
Sep 7, 2021
Merged

Add release-patch script #1554

Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4d14e71
Add release script
jklegar May 12, 2021
e8f3c6e
Add check for github cli installed
jklegar May 13, 2021
8f1240d
Add check for cherry-picking commits
jklegar May 13, 2021
964d920
Address comments
jklegar May 27, 2021
1950681
Switch changelog generator back to master
jklegar May 27, 2021
2a72352
Replace starting commit with remote option
Jun 16, 2021
2ef34a1
Replace cherry-pick by rebase in function names and user prompts
Jun 21, 2021
a487d06
Nit fixes
Aug 31, 2021
f44707c
Merge branch 'master' into jacob_release_script
Aug 31, 2021
7f23579
Merge branch 'master' into jacob_release_script
Sep 7, 2021
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
279 changes: 279 additions & 0 deletions infra/scripts/release-patch.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,279 @@
#!/usr/bin/env bash
set -eo pipefail


usage()
{
echo "usage: release-patch.sh

This script is used to release a patch release. It is untested on major/minor releases and for those, some modification may be necessary.

-v, --version version to release, example: 0.10.6
-t, --github-token personal GitHub token
-r, --remote git remote server name for the feast-dev/feast repo (e.g. origin, upstream, etc.)
"
}

while [ "$1" != "" ]; do
case "$1" in
-v | --version ) VERSION="$2"; shift;;
-t | --github-token ) GH_TOKEN="$2"; shift;;
-r | --remote ) REMOTE="$2"; shift;;
-h | --help ) usage; exit;;
* ) usage; exit 1
esac
shift
done

if [ -z $VERSION ]; then usage; exit 1; fi
if [ -z $GH_TOKEN ]; then usage; exit 1; fi
if [ -z $REMOTE ]; then usage; exit 1; fi
regex="([0-9]+)\.([0-9]+)\.([0-9]+)"
if [[ $VERSION =~ $regex ]]
then
MAJOR="${BASH_REMATCH[1]}"
MINOR="${BASH_REMATCH[2]}"
PATCH="${BASH_REMATCH[3]}"
else
usage
exit 1
fi
if ! which gh ; then echo "Please install the GitHub CLI to use this script"; exit 1; fi

echo "This script is mostly idempotent; check git status for temp files before restarting. It will always prompt you before making any non-local change."

# Go to infra/scripts directory
cd $(dirname "$0")
# Login to GitHub CLI
echo $GH_TOKEN | gh auth login --with-token
jklegar marked this conversation as resolved.
Show resolved Hide resolved

echo "Step 1: rebase new commits onto release branch"
git fetch $REMOTE
git checkout $REMOTE/master
STARTING_COMMIT=$(git merge-base $REMOTE/master v$MAJOR.$MINOR-branch)
git checkout v$MAJOR.$MINOR-branch

push_rebased_commits()
{
echo "Pushing commits"
git push $REMOTE v$MAJOR.$MINOR-branch
echo "Commits pushed"
}
rebase_from_master()
{
echo "Rebasing commits"
git checkout $REMOTE/master
git rebase --interactive --onto v$MAJOR.$MINOR-branch $STARTING_COMMIT HEAD
git branch -f v$MAJOR.$MINOR-branch HEAD
git checkout v$MAJOR.$MINOR-branch
echo "Commits rebased"
echo "Step 1b: Push commits"
read -p "Commits are not pushed. Continue (y) or skip this sub-step (n)? " choice
case "$choice" in
y|Y ) push_rebased_commits ;;
n|N ) echo "Skipping this sub-step" ;;
* ) echo "Skipping this sub-step" ;;
esac ;
}
echo "Step 1a: rebase commits"
if git status | grep -q "is ahead of" ; then
read -p "Your local branch is ahead of its remote counterpart, indicating you may have already rebased. Skip this step (y) or run the rebase starting from commit $STARTING_COMMIT (n)? " choice
case "$choice" in
y|Y ) echo "Skipping this step" ;;
n|N ) rebase_from_master ;;
* ) rebase_from_master ;;
tsotnet marked this conversation as resolved.
Show resolved Hide resolved
esac ;
else
read -p "Will rebase starting from commit $STARTING_COMMIT. Continue (y) or skip this step (n)? " choice
case "$choice" in
y|Y ) rebase_from_master ;;
n|N ) echo "Skipping this step" ;;
* ) echo "Skipping this step" ;;
tsotnet marked this conversation as resolved.
Show resolved Hide resolved
esac ;
fi

commit_changelog()
{
echo "Committing CHANGELOG.md"
git add ../../CHANGELOG.md
tsotnet marked this conversation as resolved.
Show resolved Hide resolved
git commit -m "Update CHANGELOG for Feast v$MAJOR.$MINOR.$PATCH"
}
update_changelog()
{
echo "Running changelog generator (will take up to a few minutes)"
echo -e "# Changelog\n" > temp \
&& docker run -it --rm ferrarimarco/github-changelog-generator \
--user feast-dev \
--project feast \
--release-branch master \
woop marked this conversation as resolved.
Show resolved Hide resolved
--future-release v$MAJOR.$MINOR.$PATCH \
--unreleased-only \
--no-issues \
--bug-labels kind/bug \
--enhancement-labels kind/feature \
--breaking-labels compat/breaking \
-t $GH_TOKEN \
--max-issues 1 -o \
| sed -n '/## \[v'"$MAJOR.$MINOR.$PATCH"'\]/,$p' \
| sed '$d' | sed '$d' | sed '$d' | tr -d '\r' >> temp \
&& sed '1d' ../../CHANGELOG.md >> temp && mv temp ../../CHANGELOG.md
git diff ../../CHANGELOG.md
echo "Check CHANGELOG.md carefully and fix any errors. In particular, make sure the new enhancements/PRs/bugfixes aren't already listed somewhere lower down in the file."
read -p "Once you're done checking, continue to commit the changelog (y) or exit (n)? " choice
case "$choice" in
y|Y ) commit_changelog ;;
n|N ) exit ;;
* ) exit ;;
esac ;
}
echo "Step 2: Updating CHANGELOG.md"
if grep -q "https://github.com/feast-dev/feast/tree/v$MAJOR.$MINOR.$PATCH" ../../CHANGELOG.md ; then
read -p "CHANGELOG.md appears updated. Skip this step (y/n)? " choice
case "$choice" in
y|Y ) echo "Skipping this step" ;;
n|N ) update_changelog ;;
* ) update_changelog ;;
esac ;
else
update_changelog ;
fi

tag_commit()
{
echo "Tagging commit"
git tag v$MAJOR.$MINOR.$PATCH
echo "Commit tagged"
}
echo "Step 3: Tag commit"
if git tag | grep -q "v$MAJOR.$MINOR.$PATCH" ; then
read -p "The tag already exists. Skip this step (y/n)? " choice
case "$choice" in
y|Y ) echo "Skipping this step" ;;
n|N ) tag_commit ;;
* ) tag_commit ;;
esac ;
else
tag_commit ;
fi

echo "Step 4: Push commits and tags"
push_commits()
{
echo "Pushing commits"
git push $REMOTE v$MAJOR.$MINOR-branch
echo "Commits pushed"
}
echo "Step 4a: Push commits"
if git status | grep -q "nothing to commit" ; then
echo "The commits appear pushed. Skipping this sub-step"
else
read -p "Commits are not pushed. Continue (y) or skip this sub-step (n)? " choice
case "$choice" in
y|Y ) push_commits ;;
n|N ) echo "Skipping this sub-step" ;;
* ) echo "Skipping this sub-step" ;;
esac ;
fi

push_tag()
{
echo "Pushing tag"
git push $REMOTE v$MAJOR.$MINOR.$PATCH
echo "Tag pushed"
}
echo "Step 4b: Push tag"
if git ls-remote --tags $REMOTE | grep -q "v$MAJOR.$MINOR.$PATCH" ; then
read -p "The tag appears pushed. Skip this sub-step (y/n)? " choice
case "$choice" in
y|Y ) echo "Skipping this sub-step" ;;
n|N ) push_tag ;;
* ) push_tag ;;
esac ;
else
read -p "The tag is not pushed. Continue (y) or skip this sub-step (n)? " choice
case "$choice" in
y|Y ) push_tag ;;
n|N ) echo "Skipping this sub-step" ;;
* ) echo "Skipping this sub-step" ;;
esac ;
fi

read -p "Now wait for the CI to pass. Continue (y) or exit and fix the problem (n)? " choice
tsotnet marked this conversation as resolved.
Show resolved Hide resolved
case "$choice" in
y|Y ) echo "Moving on to the next step" ;;
n|N ) exit ;;
* ) exit ;;
esac ;

echo "Step 6: Add changelog to master"
changelog_hash=$(git rev-parse HEAD)
git checkout master
cp_changelog()
{
echo "Cherry-picking"
git cherry-pick $changelog_hash
echo "Cherry-pick done"
}
echo "Step 6a: Cherry-pick changelog to master"
if grep -q "https://github.com/feast-dev/feast/tree/v$MAJOR.$MINOR.$PATCH" ../../CHANGELOG.md ; then
read -p "The changelog appears to be cherry-picked onto master. Skip this sub-step (y/n)? " choice
case "$choice" in
y|Y ) echo "Skipping this sub-step" ;;
n|N ) cp_changelog ;;
* ) cp_changelog ;;
esac ;
else
read -p "The changelog does not appear to be cherry-picked onto master. Continue (y) or skip this sub-step (n)? " choice
case "$choice" in
y|Y ) cp_changelog ;;
n|N ) echo "Skipping this sub-step" ;;
* ) echo "Skipping this sub-step" ;;
esac ;
fi

push_cp()
{
echo "Pushing cherry-pick"
git push $REMOTE master
echo "Commit pushed"
}
echo "Step 6b: Push changelog to master"
if git status | grep -q "nothing to commit" ; then
echo "The commit appears pushed. Skipping this sub-step"
else
read -p "The commit is not pushed. Continue (y) or skip this sub-step (n)? " choice
case "$choice" in
y|Y ) push_cp ;;
n|N ) echo "Skipping this sub-step" ;;
* ) echo "Skipping this sub-step" ;;
esac ;
fi

create_release()
{
echo "Creating GitHub release"
cat ../../CHANGELOG.md | sed -n '/## \[v'"$MAJOR.$MINOR.$PATCH"'\]/,/## \[v'"$MAJOR.$MINOR.$(($PATCH-1))"'\]/p' | sed -n '/**Implemented enhancements/,$p' | sed '$d' > temp2 \
&& gh release create v$MAJOR.$MINOR.$PATCH -t "Feast v$MAJOR.$MINOR.$PATCH" --repo feast-dev/feast --notes-file temp2 \
&& rm temp2
echo "GitHub release created"
}
echo "Step 7: Create a GitHub release"
if gh release list --repo feast-dev/feast | grep -q "v$MAJOR.$MINOR.$PATCH" ; then
read -p "GitHub release appears created. Skip this step (y/n)? " choice
case "$choice" in
y|Y ) echo "Skipping this step" ;;
n|N ) create_release ;;
* ) create_release ;;
esac ;
else
read -p "A GitHub release has not been created. Continue (y) or skip this step (n)? " choice
case "$choice" in
y|Y ) create_release ;;
n|N ) echo "Skipping this step" ;;
* ) echo "Skipping this step" ;;
esac ;
fi

echo "Do these final two steps on your own:"
echo "Step 8: Update the Upgrade Guide"
echo "Step 9: Update Feast Supported Versions"
tsotnet marked this conversation as resolved.
Show resolved Hide resolved