-
Notifications
You must be signed in to change notification settings - Fork 214
/
RELEASE-checklist.sh
105 lines (83 loc) · 3.1 KB
/
RELEASE-checklist.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
#!/bin/bash
echo This is not meant to be run automatically.
exit
set -e
# Make sure the build is ok via
mvn -f owasp-java-html-sanitizer clean verify jacoco:report site javadoc:jar source:jar
mvn install
mvn org.sonatype.ossindex.maven:ossindex-maven-plugin:audit
mvn -f aggregate install
echo
echo Browse to
echo "file://$PWD/owasp-java-html-sanitizer/target/site/jacoco/index.html"
echo and check the jacoco reports.
echo
echo Check https://central.sonatype.org/pages/apache-maven.html#nexus-staging-maven-plugin-for-deployment-and-release
echo and make sure you have the relevant credentials in your ~/.m2/settings.xml
echo
echo Check https://search.maven.org/#search%7Cga%7C1%7Cowasp-java-html-sanitizer
echo and make sure that the current POM release number is max.
# Pick a release version
export DATE_STAMP="$(date +'%Y%m%d')"
export NEW_VERSION="$DATE_STAMP"".1"
export NEW_DEV_VERSION="$DATE_STAMP"".2-SNAPSHOT"
echo DATE_STAMP="$DATE_STAMP"
echo NEW_VERSION="$NEW_VERSION"
echo NEW_DEV_VERSION="$NEW_DEV_VERSION"
cd ~/work
export RELEASE_CLONE="$PWD/html-san-release"
rm -rf "$RELEASE_CLONE"
cd "$(dirname "$RELEASE_CLONE")"
git clone [email protected]:OWASP/java-html-sanitizer.git \
"$(basename "$RELEASE_CLONE")"
cd "$RELEASE_CLONE"
# Update the version
# mvn release:update-versions puts -SNAPSHOT on the end no matter what
# so this is a two step process.
export VERSION_PLACEHOLDER=99999999999999-SNAPSHOT
POM_DIRS=". aggregate empiricism java8-shim java10-shim owasp-java-html-sanitizer"
for project in $POM_DIRS; do
mvn -f "$project"/pom.xml install
done
for project in $POM_DIRS; do
mvn -f "$project"/pom.xml \
release:update-versions \
-DautoVersionSubmodules=true \
-DdevelopmentVersion="$VERSION_PLACEHOLDER"
done
find . -name pom.xml \
| xargs perl -i.placeholder -pe "s/$VERSION_PLACEHOLDER/$NEW_VERSION/g"
# Make sure there's no snapshots left in any poms.
find . -name pom.xml | xargs grep -- -SNAPSHOT
./scripts/fix_javadoc_links.sh "$NEW_VERSION"
# Make sure the change log is up-to-date.
perl -i.bak \
-pe 'if (m/^ [*] / && !$added) { $_ = qq( * Release $ENV{"NEW_VERSION"}\n$_); $added = 1; }' \
change_log.md
$EDITOR change_log.md
# A dry run.
mvn -f pom.xml clean source:jar javadoc:jar verify \
-DperformRelease=true
# Commit and tag
git commit -am "Release candidate $NEW_VERSION"
git tag -m "Release $NEW_VERSION" -s "release-$NEW_VERSION"
git push origin "release-$NEW_VERSION"
# Actually deploy.
mvn -f pom.xml clean source:jar javadoc:jar verify deploy:deploy \
-DperformRelease=true
# Bump the development version.
for f in $(find . -name pom.xml.placeholder); do
mv "$f" "$(dirname "$f")"/"$(basename "$f" .placeholder)"
done
find . -name pom.xml \
| xargs perl -i -pe "s/$VERSION_PLACEHOLDER/$NEW_DEV_VERSION/"
git commit -am "Bumped dev version"
git push origin main --tags
# Now Release
echo '1. Go to oss.sonatype.org'
echo '2. Look under staging repositories for one named'
echo ' comgooglecodeowasp-java-html-sanitizer-...'
echo '3. Close it.'
echo '4. Refresh until it is marked "Closed".'
echo '5. Check that its OK.'
echo '6. Release it.'