Skip to content

Commit

Permalink
scm: Almost fully automated release procedure
Browse files Browse the repository at this point in the history
  • Loading branch information
@nielsbasjes
nielsbasjes committed Feb 13, 2023
1 parent 6b78316 commit fba3f02
Show file tree
Hide file tree
Showing 2 changed files with 197 additions and 45 deletions.
47 changes: 2 additions & 45 deletions ReleaseProcedure.txt
View file
Original file line number Diff line number Diff line change
@@ -1,50 +1,7 @@
# Release procedure.
This uses the maven-replease-plugin which has been configured to ONLY modify the local git repo.
This uses the maven-release-plugin which has been configured to ONLY modify the local git repo.

## Ensure we have all upstream updates (like patches from Renovate)
git pull

## Ensure all has been committed
git status

## Update the top of the CHANGELOG.md and website frontpage
vim CHANGELOG.md documentation/content/_index.md
git commit -m"docs: Updated CHANGELOG and website before release" CHANGELOG.md documentation/content/_index.md

## Prepare the release: Make releasable version and make tag.
mvn release:prepare

# NOTE: If you get the error
# gpg: signing failed: No pinentry
# then sometimes just doing this in a different terminal can resolve the problem:
# echo "test" | gpg --clearsign
# or even this
# while : ; do date ; echo "test" | gpg --clearsign ; sleep 10s ; done

# UNDO Procedure MANUALLY:
# mvn release:rollback will create an extra commit to rollback the changes in the pom.xml files and remove the tag but NOT everything.
# Using `git log` see how many commits must be removed.
# git reset HEAD~2

# Actually run the release: Effectively mvn deploy towards Sonatype
mvn release:perform

#
# Now check SONATYPE
#

# This now contains the latest released version
RELEASEVERSION=$(cat documentation/layouts/shortcodes/YauaaVersion.md)

git push
git push --tags

# Publish the docker image
docker push nielsbasjes/yauaa:${RELEASEVERSION}
docker push nielsbasjes/yauaa:latest

# Upload logstash gem to github.com
# ${project.basedir}/target/checkout/udfs/elastic/logstash/logstash-filter/target/logstash-filter-yauaa-x.x.x.gem
Run the ./devtools/release.sh script

#######################

Expand Down
195 changes: 195 additions & 0 deletions devtools/release.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
#!/bin/bash
#
# Yet Another UserAgent Analyzer
# Copyright (C) 2013-2023 Niels Basjes
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

# Release procedure.
# This uses the maven-release-plugin which has been configured to ONLY modify the local git repo.

# ----------------------------------------------------------------------------------------------------
SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"

echo "PWD: ${SCRIPTDIR}"

cd "${SCRIPTDIR}/.." || ( echo "This should not be possible" ; exit 1 )

# Working directory is now the root of the project

# ----------------------------------------------------------------------------------------------------
#https://wiki.archlinux.org/index.php/Color_Bash_Prompt
# Reset
export Color_Off='\e[0m' # Text Reset

# High Intensity
export IRed='\e[0;91m' # Red
export IYellow='\e[0;93m' # Yellow
export IBlue='\e[0;94m' # Blue
export IWhite='\e[0;97m' # White

# Bold High Intensity
export BIRed='\e[1;91m' # Red
export BIYellow='\e[1;93m' # Yellow
export BIGreen='\e[1;92m' # Green
export BIBlue='\e[1;94m' # Blue

function info() {
echo -e "${Color_Off}${IWhite}[${BIBlue}INFO${IWhite}] ${Color_Off}${1}"
}

function pass() {
echo -e "${Color_Off}${IWhite}[${BIGreen}PASS${IWhite}] ${Color_Off}${1}"
}

function warn() {
echo -e "${Color_Off}${IWhite}[${BIYellow}WARN${IWhite}] ${IYellow}${1}${Color_Off}"
}

function fail() {
echo -e "${Color_Off}${IWhite}[${BIRed}FAIL${IWhite}] ${IRed}${1}${Color_Off}"
}

function die() {
echo -e "${Color_Off}"
echo -e "${IWhite}[${BIRed}FAIL${IWhite}] ${IYellow}/========================================================================"
echo -e "${IWhite}[${BIRed}FAIL${IWhite}] ${IYellow}| ${BIRed} ---------->>> PROCESS WAS ABORTED <<<---------- ${IYellow}"
echo -e "${IWhite}[${BIRed}FAIL${IWhite}] ${IYellow}| ${BIRed} $* ${IYellow}"
echo -e "${IWhite}[${BIRed}FAIL${IWhite}] ${IYellow}\\========================================================================"
echo -e "${Color_Off}"
exit 1
}

# ----------------------------------------------------------------------------------------------------

# Pre flight checks
## Ensure all has been committed
info "Checking tree status"
if [[ -z $(git status -s) ]]
then
pass "Tree is clean"
else
git status
die "Tree is dirty, must commit everything"
fi

## Ensure we have all upstream updates (like patches from Renovate)
info "Checking up to date status"
git pull
gitPullStatus=$?
if [ ${gitPullStatus} -ne 0 ];
then
fail "We just received changes."
exit ${gitPullStatus}
else
pass "Everything is up to date."
fi

# ----------------------------------------------------------------------------------------------------
## Update the top of the CHANGELOG.md and website frontpage
vim CHANGELOG.md documentation/content/_index.md
git commit -m"docs: Updated CHANGELOG and website before release" CHANGELOG.md documentation/content/_index.md

# ----------------------------------------------------------------------------------------------------
info "GPG workaround: Starting"
runGpgSignerInBackGround(){
(
while : ; do date ; echo "test" | gpg --clearsign ; sleep 10s ; done
) > /dev/null 2>&1
}

runGpgSignerInBackGround&
GpgSignerPID=$!

info "GPG workaround: Running (PID=${GpgSignerPID})"

killSigner() {
info "GPG workaround: Killing (PID=${GpgSignerPID})"
kill ${GpgSignerPID}
info "GPG workaround: Killed"
}

trap killSigner EXIT
trap killSigner SIGINT

# ----------------------------------------------------------------------------------------------------
## Prepare the release: Make releasable version and make tag.
info "Doing release:prepare"
mvn release:prepare
prepareStatus=$?
if [ ${prepareStatus} -ne 0 ];
then
fail "Release prepare failed."
exit ${prepareStatus}
else
pass "Release prepare Success."
fi

# ----------------------------------------------------------------------------------------------------
# Check if build for this tag is reproducible
git checkout "$(git describe --abbrev=0)"
mvn clean install -PskipQuality
mvn clean verify -PskipQuality artifact:compare
reproducibleStatus=$?
git switch -
if [ ${reproducibleStatus} -ne 0 ];
then
fail "Build is NOT reproducible."
exit ${reproducibleStatus}
else
pass "Build is reproducible."
fi

# ----------------------------------------------------------------------------------------------------
# Actually run the release: Effectively mvn deploy towards Sonatype
info "Doing release:perform"
mvn release:perform
performStatus=$?
if [ ${performStatus} -ne 0 ];
then
fail "Release perform failed."
exit ${performStatus}
else
pass "Release perform Success."
fi

# ----------------------------------------------------------------------------------------------------
#
# Now check SONATYPE
#
info "Now verify Sonatype"
warn "Press any key abort or 'c' to continue"
read -n 1 k <&1
if [[ $k = c ]] ;
then
pass "Release worked, pushing results"
else
die "Aborting, nothing was pushed."
fi

warn "Now go and manually push it all"

# ----------------------------------------------------------------------------------------------------
echo "git push"
echo "git push --tags"

# Publish the docker image
RELEASEVERSION=$(git describe --abbrev=0| sed 's/^v//')
echo "docker push \"nielsbasjes/yauaa:${RELEASEVERSION}\""
echo "docker push \"nielsbasjes/yauaa:latest\""

info "Upload logstash gem to github.com"
warn "${PWD}/target/checkout/udfs/elastic/logstash/logstash-filter/target/logstash-filter-yauaa-*.gem"

# ----------------------------------------------------------------------------------------------------

0 comments on commit fba3f02

Please sign in to comment.