Skip to content

chore: Extend post-release script to update docker-images Changelog #92

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 3 commits into from
Nov 20, 2024
Merged

chore: Extend post-release script to update docker-images Changelog #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15824ab
chore: Extend post-release script to update docker-images Changelog
NickLarsenNZ Nov 19, 2024
7a70ab5
chore: explicitly sign commits
NickLarsenNZ Nov 19, 2024
5121d6a
Apply suggestions from code review
NickLarsenNZ Nov 20, 2024
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
6 changes: 4 additions & 2 deletions release/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,15 +166,17 @@ e.g.
Some post release steps are performed with `release/post-release.sh` script, called from the repository root folder. The syntax is given below:

```
./release/post-release.sh -t <release-tag> [-p]
./release/post-release.sh -t <release-tag> [-p] [-w products|operators|all]
```

- `-t <release-tag>`: the release tag (mandatory). This must be a semver-compatible value (i.e. major/minor/path, without leading zeros) such as `23.1.0`, `23.10.3` etc. and will be used to create a tag with the name
- `-p`: push flag (optional, default is "false"). If provided, the created commits and tags made as part of this process will be pushed to the origin.
- `-w`: which repositories to update the changelogs for. It can be "products", "operators", "all" (defaults to "all").

##### What this script does

- checks that the release tag exists and that the all operator repositories have a clean working copy
- checks that the release tag exists and that all operator repositories have a clean working copy
- checks that the release tag exists and that the docker-images repository has a clean working copy
- merges the CHANGELOG.md from the release tag into main
- creates PRs for all operators

Expand Down
128 changes: 102 additions & 26 deletions release/post-release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,17 @@ set -x
# this is needed for cargo commands to work properly
#-----------------------------------------------------------
TAG_REGEX="^[0-9][0-9]\.([1-9]|[1][0-2])\.[0-9]+$"
REPOSITORY="origin"
REMOTE="origin"

parse_inputs() {
RELEASE_TAG=""
PUSH=false
WHAT="all"

while [[ "$#" -gt 0 ]]; do
case $1 in
-t|--tag) RELEASE_TAG="$2"; shift ;;
-w|--what) WHAT="$2"; shift ;;
-p|--push) PUSH=true ;;
*) echo "Unknown parameter passed: $1"; exit 1 ;;
esac
Expand All @@ -35,45 +37,50 @@ parse_inputs() {
RELEASE_BRANCH="release-$RELEASE"

INITIAL_DIR="$PWD"
DOCKER_IMAGES_REPO=$(yq '... comments="" | .images-repo ' "$INITIAL_DIR"/release/config.yaml)
TEMP_RELEASE_FOLDER="/tmp/stackable-$RELEASE_BRANCH"

echo "Settings: ${RELEASE_BRANCH}: Push: $PUSH"
echo "Settings: $RELEASE_BRANCH: Push: $PUSH"
}

# Check that the operator repos have been cloned locally, and that the release
# branch and tag exists.
check_operators() {
while IFS="" read -r operator || [ -n "$operator" ]
while IFS="" read -r OPERATOR || [ -n "$OPERATOR" ]
do
echo "Operator: $operator"
if [ ! -d "$TEMP_RELEASE_FOLDER/${operator}" ]; then
echo "Expected folder is missing: $TEMP_RELEASE_FOLDER/${operator}"
echo "Operator: $OPERATOR"
if [ ! -d "$TEMP_RELEASE_FOLDER/$OPERATOR" ]; then
echo "Expected folder is missing: $TEMP_RELEASE_FOLDER/$OPERATOR"
exit 1
fi

cd "$TEMP_RELEASE_FOLDER/${operator}"
cd "$TEMP_RELEASE_FOLDER/$OPERATOR"

DIRTY_WORKING_COPY=$(git status --short)
if [ -n "${DIRTY_WORKING_COPY}" ]; then
echo "Dirty working copy found for operator ${operator}"
if [ -n "$DIRTY_WORKING_COPY" ]; then
echo "Dirty working copy found for operator $OPERATOR"
exit 1
fi
BRANCH_EXISTS=$(git branch | grep "$RELEASE_BRANCH")
if [ -z "${BRANCH_EXISTS}" ]; then
echo "Expected release branch is missing: ${operator}/$RELEASE_BRANCH"
if [ -z "$BRANCH_EXISTS" ]; then
echo "Expected release branch is missing: $OPERATOR/$RELEASE_BRANCH"
exit 1
fi
git fetch --tags
TAG_EXISTS=$(git tag | grep "$RELEASE_TAG")
if [ -z "${TAG_EXISTS}" ]; then
echo "Expected tag $RELEASE_TAG missing for operator ${operator}"
if [ -z "$TAG_EXISTS" ]; then
echo "Expected tag $RELEASE_TAG missing for operator $OPERATOR"
exit 1
fi
done < <(yq '... comments="" | .operators[] ' "$INITIAL_DIR"/release/config.yaml)
}

update_main_changelog() {
while IFS="" read -r operator || [ -n "$operator" ]
# Update the operator changelogs on main, and check they do not differ from
# the changelog in the release branch.
update_operators() {
while IFS="" read -r OPERATOR || [ -n "$OPERATOR" ]
do
cd "$TEMP_RELEASE_FOLDER/${operator}"
cd "$TEMP_RELEASE_FOLDER/$OPERATOR"
# New branch that updates the CHANGELOG
CHANGELOG_BRANCH="update-changelog-from-release-$RELEASE_TAG"
# Branch out from main
Expand All @@ -84,20 +91,76 @@ update_main_changelog() {
# are no conflicts.
CHANGELOG_MODIFIED=$(git status --short)
if [ "M CHANGELOG.md" != "$CHANGELOG_MODIFIED" ]; then
echo "Failed to update CHANGELOG.md in main for operator ${operator}"
echo "Failed to update CHANGELOG.md in main for operator $OPERATOR"
exit 1
fi
# Commit the updated CHANGELOG.
git add CHANGELOG.md
git commit -m "Update CHANGELOG.md from release $RELEASE_TAG"
git commit -sm "Update CHANGELOG.md from release $RELEASE_TAG"
# Maybe push and create pull request
if "$PUSH"; then
git push -u "$REPOSITORY" "$CHANGELOG_BRANCH"
git push -u "$REMOTE" "$CHANGELOG_BRANCH"
gh pr create --fill --reviewer stackable/developers --head "$CHANGELOG_BRANCH" --base main
fi
done < <(yq '... comments="" | .operators[] ' "$INITIAL_DIR"/release/config.yaml)
}

# Check that the docker-images repo has been cloned locally, and that the release
# branch and tag exists.
check_docker_images() {
echo "docker-images"
if [ ! -d "$TEMP_RELEASE_FOLDER/$DOCKER_IMAGES_REPO" ]; then
echo "Expected folder is missing: $TEMP_RELEASE_FOLDER/$DOCKER_IMAGES_REPO"
exit 1
fi

cd "$TEMP_RELEASE_FOLDER/$DOCKER_IMAGES_REPO"

DIRTY_WORKING_COPY=$(git status --short)
if [ -n "${DIRTY_WORKING_COPY}" ]; then
echo "Dirty working copy found for $DOCKER_IMAGES_REPO"
exit 1
fi
BRANCH_EXISTS=$(git branch | grep "$RELEASE_BRANCH")
if [ -z "${BRANCH_EXISTS}" ]; then
echo "Expected release branch is missing: $DOCKER_IMAGES_REPO/$RELEASE_BRANCH"
exit 1
fi
git fetch --tags
TAG_EXISTS=$(git tag | grep "$RELEASE_TAG")
if [ -z "${TAG_EXISTS}" ]; then
echo "Expected tag $RELEASE_TAG missing for $DOCKER_IMAGES_REPO"
exit 1
fi
}

# Update the docker-images changelogs on main, and check they do not differ from
# the changelog in the release branch.
update_docker_images() {
cd "$TEMP_RELEASE_FOLDER/$DOCKER_IMAGES_REPO"
# New branch that updates the CHANGELOG
CHANGELOG_BRANCH="update-changelog-from-release-$RELEASE_TAG"
# Branch out from main
git switch -c "$CHANGELOG_BRANCH" main
# Checkout CHANGELOG changes from the release tag
git checkout "$RELEASE_TAG" -- CHANGELOG.md
# Ensure only the CHANGELOG has been modified and there
# are no conflicts.
CHANGELOG_MODIFIED=$(git status --short)
if [ "M CHANGELOG.md" != "$CHANGELOG_MODIFIED" ]; then
echo "Failed to update CHANGELOG.md in main for $DOCKER_IMAGES_REPO"
exit 1
fi
# Commit the updated CHANGELOG.
git add CHANGELOG.md
git commit -sm "Update CHANGELOG.md from release $RELEASE_TAG"
# Maybe push and create pull request
if "$PUSH"; then
git push -u "$REMOTE" "$CHANGELOG_BRANCH"
gh pr create --fill --reviewer stackable/developers --head "$CHANGELOG_BRANCH" --base main
fi
}


main() {
parse_inputs "$@"
Expand All @@ -118,14 +181,27 @@ main() {
exit 1
fi

# sanity checks before we start: folder, branches etc.
# deactivate -e so that piped commands can be used
set +e
check_operators
set -e
if [ "products" == "$WHAT" ] || [ "all" == "$WHAT" ]; then
# sanity checks before we start: folder, branches etc.
# deactivate -e so that piped commands can be used
set +e
check_docker_images
set -e

echo "Update $DOCKER_IMAGES_REPO main changelog for release $RELEASE_TAG"
update_docker_images
fi
if [ "operators" == "$WHAT" ] || [ "all" == "$WHAT" ]; then
# sanity checks before we start: folder, branches etc.
# deactivate -e so that piped commands can be used
set +e
check_operators
set -e

echo "Update the operator main changelog for release $RELEASE_TAG"
update_operators
fi

echo "Update main changelog from release $RELEASE_TAG"
update_main_changelog
}

main "$@"