pmd/do-release.sh

311 lines
11 KiB
Bash
Raw Normal View History

2020-04-18 10:28:37 +02:00
#!/usr/bin/env bash
# abort the script on the first failing sub command
set -e
2015-09-18 11:25:30 +02:00
# Make sure, everything is English...
export LANG=C.UTF-8
2015-09-18 11:25:30 +02:00
# verify the current directory
if [ ! -f pom.xml ] || [ ! -d ../pmd.github.io ]; then
2016-01-07 10:14:24 +01:00
echo "You seem to be in the wrong working directory or you don't have pmd.github.io checked out..."
2015-09-18 11:25:30 +02:00
echo
echo "Expected:"
echo "* You are currently in the pmd repository"
echo "* ../pmd.github.io is the pmd.github.io repository"
echo
exit 1
fi
CURRENT_BRANCH=
echo "-------------------------------------------"
echo "Releasing PMD"
echo "-------------------------------------------"
# allow to override the release version, e.g. via "RELEASE_VERSION=7.0.0-rc1 ./do-release.sh"
if [ "$RELEASE_VERSION" = "" ]; then
CURRENT_VERSION=$(./mvnw org.apache.maven.plugins:maven-help-plugin:3.2.0:evaluate -Dexpression=project.version -q -DforceStdout)
RELEASE_VERSION=${CURRENT_VERSION%-SNAPSHOT}
fi
MAJOR=$(echo "$RELEASE_VERSION" | cut -d . -f 1)
MINOR=$(echo "$RELEASE_VERSION" | cut -d . -f 2)
PATCH=$(echo "$RELEASE_VERSION" | cut -d . -f 3)
if [ "$PATCH" == "0" ]; then
NEXT_MINOR=$(("${MINOR}" + 1))
NEXT_PATCH="0"
LAST_MINOR=$(("${MINOR}" - 1))
2020-04-18 10:28:37 +02:00
LAST_PATCH="0"
else
# this is a bugfixing release
NEXT_MINOR="${MINOR}"
NEXT_PATCH=$(("${PATCH}" + 1))
2020-04-18 10:28:37 +02:00
LAST_MINOR="${MINOR}"
LAST_PATCH=$(("${PATCH}" - 1))
fi
# allow to override the next version, e.g. via "DEVELOPMENT_VERSION=7.0.0-SNAPSHOT ./do-release.sh"
if [ "$DEVELOPMENT_VERSION" = "" ]; then
DEVELOPMENT_VERSION="$MAJOR.$NEXT_MINOR.$NEXT_PATCH-SNAPSHOT"
fi
# allow to override the last version, e.g. via "LAST_VERSION=6.55.0 ./do-release.sh"
if [ "$LAST_VERSION" = "" ]; then
LAST_VERSION="$MAJOR.$LAST_MINOR.$LAST_PATCH"
fi
# http://stackoverflow.com/questions/1593051/how-to-programmatically-determine-the-current-checked-out-git-branch
CURRENT_BRANCH=$(git symbolic-ref -q HEAD)
CURRENT_BRANCH=${CURRENT_BRANCH##refs/heads/}
CURRENT_BRANCH=${CURRENT_BRANCH:-HEAD}
2020-04-18 10:28:37 +02:00
echo "LAST_VERSION: ${LAST_VERSION}"
echo "RELEASE_VERSION: ${RELEASE_VERSION} (this release)"
echo "DEVELOPMENT_VERSION: ${DEVELOPMENT_VERSION} (the next version after the release)"
echo "CURRENT_BRANCH: ${CURRENT_BRANCH}"
echo
echo "Is this correct?"
echo
2020-04-18 10:28:37 +02:00
echo "Press enter to continue... (or CTRL+C to cancel)"
read -r
2015-09-18 11:25:30 +02:00
2020-04-18 10:28:37 +02:00
export LAST_VERSION
2015-09-18 11:25:30 +02:00
export RELEASE_VERSION
export DEVELOPMENT_VERSION
export CURRENT_BRANCH
# check for SNAPSHOT version of pmd.build-tools.version
BUILD_TOOLS_VERSION=$(./mvnw org.apache.maven.plugins:maven-help-plugin:3.2.0:evaluate -Dexpression=pmd.build-tools.version -q -DforceStdout)
BUILD_TOOLS_VERSION_RELEASE=${BUILD_TOOLS_VERSION%-SNAPSHOT}
if [ "${BUILD_TOOLS_VERSION}" != "${BUILD_TOOLS_VERSION_RELEASE}" ]; then
echo "Error: version pmd.build-tools.version is ${BUILD_TOOLS_VERSION} - snapshot is not allowed"
exit 1
fi
RELEASE_RULESET="pmd-core/src/main/resources/rulesets/releases/${RELEASE_VERSION//\./}.xml"
echo "* Update date info in **docs/_config.yml**."
2018-08-15 04:08:15 +02:00
echo " date: $(date -u +%d-%B-%Y)"
2017-12-15 15:27:57 +01:00
echo
echo "* Update version info in **docs/_config.yml**."
echo " remove the SNAPSHOT from site.pmd.version"
echo
2018-08-15 04:08:15 +02:00
echo "* Ensure all the new rules are listed in the proper file:"
echo " ${RELEASE_RULESET}"
2015-09-18 11:25:30 +02:00
echo
echo "* Update **pmd-apex/src/main/resources/rulesets/apex/quickstart.xml** and"
2019-03-31 11:54:23 +02:00
echo " **pmd-java/src/main/resources/rulesets/java/quickstart.xml** with the new rules."
echo
2018-11-12 20:14:54 +01:00
echo "* Update **docs/pages/next_major_development.md** with the API changes for"
2020-05-29 09:01:21 +02:00
echo " the new release based on the release notes. Also add any deprecated rules to the list."
2018-11-12 20:14:54 +01:00
echo
2017-12-15 15:27:57 +01:00
echo "* Update **../pmd.github.io/_config.yml** to mention the new release"
echo
echo "* Update property \`pmd-designer.version\` in **pom.xml** to reference the version, that will be released"
echo " later in this process."
echo
2015-09-18 11:25:30 +02:00
echo "Press enter to continue..."
read -r
2020-04-18 10:28:37 +02:00
# calculating stats for release notes
STATS=$(
2023-03-02 10:26:18 +01:00
echo "### 📈 Stats"
echo "* $(git log pmd_releases/"${LAST_VERSION}"..HEAD --oneline --no-merges |wc -l) commits"
echo "* $(curl -s "https://api.github.com/repos/pmd/pmd/milestones?state=all&direction=desc&per_page=5"|jq ".[] | select(.title == \"$RELEASE_VERSION\") | .closed_issues") closed tickets & PRs"
echo "* Days since last release: $(( ( $(date +%s) - $(git log --max-count=1 --format="%at" pmd_releases/"${LAST_VERSION}") ) / 86400))"
2020-04-18 10:28:37 +02:00
)
TEMP_RELEASE_NOTES=$(cat docs/pages/release_notes.md)
TEMP_RELEASE_NOTES=${TEMP_RELEASE_NOTES/\{\% endtocmaker \%\}/${STATS//\&/\\\&}$'\n'$'\n'\{\% endtocmaker \%\}$'\n'}
2020-04-18 10:28:37 +02:00
echo "${TEMP_RELEASE_NOTES}" > docs/pages/release_notes.md
echo
echo "Updated stats in release notes:"
echo "$STATS"
echo
2020-04-24 08:41:01 +02:00
echo "Please verify docs/pages/release_notes.md"
2020-04-18 10:28:37 +02:00
echo
2020-04-24 08:41:01 +02:00
echo "Press enter to continue..."
read -r
2020-04-18 10:28:37 +02:00
# install bundles needed for rendering release notes
bundle config set --local path vendor/bundle
bundle config set --local with release_notes_preprocessing
bundle install
RELEASE_NOTES_POST="_posts/$(date -u +%Y-%m-%d)-PMD-${RELEASE_VERSION}.md"
export RELEASE_NOTES_POST
echo "Generating ../pmd.github.io/${RELEASE_NOTES_POST}..."
NEW_RELEASE_NOTES=$(bundle exec docs/render_release_notes.rb docs/pages/release_notes.md | tail -n +6)
cat > "../pmd.github.io/${RELEASE_NOTES_POST}" <<EOF
---
layout: post
title: PMD ${RELEASE_VERSION} released
---
${NEW_RELEASE_NOTES}
EOF
2015-09-18 11:25:30 +02:00
echo "Committing current changes (pmd)"
if [[ -e "${RELEASE_RULESET}" ]]
then
git add "${RELEASE_RULESET}"
fi
2015-09-18 11:25:30 +02:00
git commit -a -m "Prepare pmd release ${RELEASE_VERSION}"
(
cd ../pmd.github.io
git add "${RELEASE_NOTES_POST}"
changes=$(git status --porcelain 2>/dev/null| grep -c -E "^[AMDRC]")
if [ "$changes" -gt 0 ]; then
2019-10-31 18:27:57 +01:00
echo "Committing current changes (pmd.github.io)"
git commit -a -m "Prepare pmd release ${RELEASE_VERSION}" && git push
fi
2015-09-18 11:25:30 +02:00
)
# check that there are no uncommitted changes
UNCOMMITTED_CHANGES=$(git status --short --untracked-files=no)
if [ -n "${UNCOMMITTED_CHANGES}" ]; then
echo "There are uncommitted changes:"
echo "${UNCOMMITTED_CHANGES}"
exit 1
fi
# check that there are no SNAPSHOT dependencies -> done by the enforcer plugin, see enforce-no-snapshots
echo "Change version in the POMs to ${RELEASE_VERSION} and update build timestamp"
./mvnw --quiet versions:set -DnewVersion="${RELEASE_VERSION}" -DgenerateBackupPoms=false -DupdateBuildOutputTimestampPolicy=always
echo "Transform the SCM information in the POM"
sed -i "s|<tag>.\+</tag>|<tag>pmd_releases/${RELEASE_VERSION}</tag>|" pom.xml
echo "Run the project tests against the changed POMs to confirm everything is in running order (skipping cli and dist)"
./mvnw clean verify -Dskip-cli-dist -Pgenerate-rule-docs
echo "Commit and create tag"
git commit -a -m "[release] prepare release pmd_releases/${RELEASE_VERSION}"
git tag -m "[release] copy for tag pmd_releases/${RELEASE_VERSION}" "pmd_releases/${RELEASE_VERSION}"
echo "Update POMs to set the new development version ${DEVELOPMENT_VERSION}"
./mvnw --quiet versions:set -DnewVersion="${DEVELOPMENT_VERSION}" -DgenerateBackupPoms=false -DupdateBuildOutputTimestampPolicy=never
sed -i "s|<tag>.\+</tag>|<tag>HEAD</tag>|" pom.xml
echo "Commit"
git commit -a -m "[release] prepare for next development iteration"
echo "Push branch and tag pmd_releases/${RELEASE_VERSION}"
git push origin "${CURRENT_BRANCH}"
git push origin tag "pmd_releases/${RELEASE_VERSION}"
2015-09-18 11:25:30 +02:00
echo
2020-12-04 17:34:09 +01:00
echo "Tag has been pushed.... now check github actions: <https://github.com/pmd/pmd/actions>"
2015-09-18 11:25:30 +02:00
echo
echo
echo "Press enter to continue..."
read -r
2015-09-18 11:25:30 +02:00
echo
echo "Check the milestone on github:"
echo "<https://github.com/pmd/pmd/milestones>"
echo " --> move any open issues to the next milestone, close the current milestone"
2015-09-18 11:25:30 +02:00
echo
echo
echo "Prepare Next development version:"
echo "* Update version/date info in **docs/_config.yml**."
2020-05-24 18:14:55 +02:00
echo " move version to previous_version, increase version, make sure it is a SNAPSHOT version"
echo " otherwise the javadoc links won't work during development"
echo " also update the date, e.g. ??-month-year."
2015-09-18 11:25:30 +02:00
echo
2018-05-29 16:08:48 -03:00
echo
echo "Press enter to continue..."
read -r
2018-05-29 16:08:48 -03:00
# update release_notes_old
OLD_RELEASE_NOTES=$(tail -n +8 docs/pages/release_notes_old.md)
OLD_RELEASE_NOTES_HEADER=$(head -n 7 docs/pages/release_notes_old.md)
echo "${OLD_RELEASE_NOTES_HEADER}
${NEW_RELEASE_NOTES}
2021-04-24 18:37:53 +02:00
${OLD_RELEASE_NOTES}" > docs/pages/release_notes_old.md
2018-05-29 16:08:48 -03:00
# reset release notes template
cat > docs/pages/release_notes.md <<EOF
---
title: PMD Release Notes
permalink: pmd_release_notes.html
keywords: changelog, release notes
---
2015-09-18 11:25:30 +02:00
## {{ site.pmd.date }} - {{ site.pmd.version }}
2015-09-18 11:25:30 +02:00
2018-08-15 04:08:15 +02:00
The PMD team is pleased to announce PMD {{ site.pmd.version }}.
2018-08-15 04:08:15 +02:00
This is a {{ site.pmd.release_type }} release.
2015-09-18 11:25:30 +02:00
{% tocmaker is_release_notes_processor %}
2015-09-18 11:25:30 +02:00
2023-03-02 10:26:18 +01:00
### 🚀 New and noteworthy
2015-09-18 11:25:30 +02:00
2023-03-02 10:26:18 +01:00
### 🐛 Fixed Issues
2015-09-18 11:25:30 +02:00
2023-03-02 10:26:18 +01:00
### 🚨 API Changes
2023-03-02 10:26:18 +01:00
### ✨ External Contributions
2015-09-18 11:25:30 +02:00
2018-08-18 17:39:29 +02:00
{% endtocmaker %}
2015-09-18 11:25:30 +02:00
EOF
2018-05-29 16:08:48 -03:00
git commit -a -m "[release] Prepare next development version [skip ci]"
git push origin "${CURRENT_BRANCH}"
echo
2015-09-18 11:25:30 +02:00
echo
echo
echo "* Wait until the new version is synced to maven central and appears as latest version in"
echo " <https://repo.maven.apache.org/maven2/net/sourceforge/pmd/pmd/maven-metadata.xml>."
echo
echo
echo "Then proceed with releasing pmd-designer..."
echo "<https://github.com/pmd/pmd-designer/blob/master/releasing.md>"
echo
echo "Press enter to continue when pmd-designer is available in maven-central..."
echo "<https://repo.maven.apache.org/maven2/net/sourceforge/pmd/pmd-ui/maven-metadata.xml>."
echo
echo "Note: If there is no new pmd-designer release needed, you can directly proceed."
read -r
echo
echo "Continuing with release of pmd-cli and pmd-dist..."
echo
echo "Go to <https://github.com/pmd/pmd/actions/workflows/build.yml> and manually trigger a new build"
echo "from tag 'pmd_releases/${RELEASE_VERSION}' and with option 'Build only modules cli and dist' checked."
echo
echo "This triggers the second stage release and eventually publishes the release on GitHub."
echo
echo "Now check github actions: <https://github.com/pmd/pmd/actions>"
echo
2015-09-18 11:25:30 +02:00
echo
echo "Verify the new release on github: <https://github.com/pmd/pmd/releases/tag/pmd_releases/${RELEASE_VERSION}>"
echo "and the news entry at <https://sourceforge.net/p/pmd/news/>"
2015-09-18 11:25:30 +02:00
echo
echo "* Send out an announcement mail to the mailing list:"
2015-09-18 11:25:30 +02:00
echo
echo "To: PMD Developers List <pmd-devel@lists.sourceforge.net>"
echo "Subject: [ANNOUNCE] PMD ${RELEASE_VERSION} released"
echo
echo " You can copy the same text from <https://sourceforge.net/p/pmd/news/>."
echo
2015-09-18 11:25:30 +02:00
echo
tweet="PMD ${RELEASE_VERSION} released: https://github.com/pmd/pmd/releases/tag/pmd_releases/${RELEASE_VERSION} #PMD"
tweet="${tweet// /%20}"
tweet="${tweet//:/%3A}"
tweet="${tweet//#/%23}"
tweet="${tweet//\//%2F}"
tweet="${tweet//$'\r'/}"
tweet="${tweet//$'\n'/%0A}"
echo "* Tweet about this release on https://twitter.com/pmd_analyzer:"
echo " <https://twitter.com/intent/tweet?text=$tweet>"
echo
2015-09-18 11:25:30 +02:00
echo "------------------------------------------"
echo "Done."
echo "------------------------------------------"
echo