Visitar URL original
Update release guide · apache/polygene-java@49e6259 · GitHub
Skip to content
This repository was archived by the owner on May 12, 2021. It is now read-only.

Commit 49e6259

Browse files
eskatoseskatos
committed
Update release guide
- add tl;dr - remove mentions of a binary distribution - fix maven convenience binary staging - minor edits (wording, commit messages etc..)
1 parent 1bdeea8 commit 49e6259

1 file changed

Lines changed: 15 additions & 79 deletions

File tree

‎manual/src/docs/tutorials/howto-releasing-apache.txt‎

Lines changed: 15 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ It is intended to be a recommendation of best practices for the Apache Polygene
3333
The instructions provided here are consistent with, but not a replacement for the https://www.apache.org/dev/release.html[ASF Release Guidelines].
3434

3535

36+
== TL;DR
37+
38+
- Build and publish/stage release candidate bits
39+
- VOTE thread
40+
- NO: clean things up
41+
- YES: promote the release candidate bits as final and update all properties
42+
3643

3744
== Preparing a release
3845

@@ -271,14 +278,6 @@ Also review the release distributions in `distributions/build/distributions` whe
271278
[source,shell]
272279
----
273280
.
274-
├── apache-polygene-java-<RELEASE-VERSION>-bin.tgz
275-
├── apache-polygene-java-<RELEASE-VERSION>-bin.tgz.MD5
276-
├── apache-polygene-java-<RELEASE-VERSION>-bin.tgz.SHA-512
277-
├── apache-polygene-java-<RELEASE-VERSION>-bin.tgz.asc
278-
├── apache-polygene-java-<RELEASE-VERSION>-bin.zip
279-
├── apache-polygene-java-<RELEASE-VERSION>-bin.zip.MD5
280-
├── apache-polygene-java-<RELEASE-VERSION>-bin.zip.SHA-512
281-
├── apache-polygene-java-<RELEASE-VERSION>-bin.zip.asc
282281
├── apache-polygene-java-<RELEASE-VERSION>-src.tgz
283282
├── apache-polygene-java-<RELEASE-VERSION>-src.tgz.MD5
284283
├── apache-polygene-java-<RELEASE-VERSION>-src.tgz.SHA-512
@@ -330,7 +329,7 @@ Stage artifacts to https://repository.apache.org/[repository.apache.org] :
330329
[source,shell]
331330
----
332331
cd polygene-java
333-
./gradlew -Dversion="<RELEASE-VERSION>" publishAsfMavenArtifacts
332+
./gradlew -Dversion="<RELEASE-VERSION>" uploadArchives
334333
----
335334

336335
Close the staging Nexus repository by following the https://www.apache.org/dev/publishing-maven-artifacts.html#close-stage[Closing the staged repository] guide.
@@ -356,8 +355,8 @@ that the new version was published and is tagged as `beta`.
356355

357356
=== Upload RC distributions
358357

359-
Source and binary distributions, checksums and signatures must be uploaded to https://dist.apache.org/repos/dist/dev/polygene/[dist.apache.org/repos/dist/dev/polygene].
360-
This build created these in the `buid/distributions` directory, named `apache-polygene-java-<RELEASE-VERSION>-[src|bin]*.*`.
358+
Source distribution, checksums and signatures must be uploaded to https://dist.apache.org/repos/dist/dev/polygene/[dist.apache.org/repos/dist/dev/polygene].
359+
This build created these in the `buid/distributions` directory, named `apache-polygene-java-<RELEASE-VERSION>-src*.*`.
361360
As this release still is a simple candidate, we'll rename them before upload to advertise this in their names.
362361

363362
[source,shell]
@@ -380,24 +379,6 @@ cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEAS
380379
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz.SHA-512"
381380
cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEASE-VERSION>-src.tgz.asc" \
382381
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz.asc"
383-
# Binary ZIP
384-
cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEASE-VERSION>-bin.zip" \
385-
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip"
386-
cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEASE-VERSION>-bin.zip.MD5" \
387-
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.MD5"
388-
cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEASE-VERSION>-bin.zip.SHA-512" \
389-
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.SHA-512"
390-
cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEASE-VERSION>-bin.zip.asc" \
391-
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.asc"
392-
# Binary TAR.GZ
393-
cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEASE-VERSION>-bin.tgz" \
394-
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz"
395-
cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEASE-VERSION>-bin.tgz.MD5" \
396-
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.MD5"
397-
cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEASE-VERSION>-bin.tgz.SHA-512" \
398-
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.SHA-512"
399-
cp "polygene-java/distributions/build/distributions/apache-polygene-java-<RELEASE-VERSION>-bin.tgz.asc" \
400-
"polygene-dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.asc"
401382
----
402383

403384
And then upload them:
@@ -406,7 +387,7 @@ And then upload them:
406387
----
407388
cd polygene-dist/dev/polygene
408389
svn add * --force
409-
svn commit -m "polygene: upload <RELEASE-VERSION> to dist/dev/polygene"
390+
svn commit -m "polygene: upload <RELEASE-VERSION>-RC# to dist/dev/polygene"
410391
----
411392

412393

@@ -447,10 +428,6 @@ The vote is open for the next 72 hours and passes if a majority of at least thre
447428
[ ] 0 I don't have a strong opinion about this, but I assume it's ok
448429
[ ] -1 Do not release Apache Polygene (Java Edition) <RELEASE-VERSION> because...
449430

450-
Here is my vote:
451-
452-
+1 (binding)
453-
454431
Cheers
455432
----
456433

@@ -500,14 +477,6 @@ Put them in a directory:
500477
[source,shell]
501478
----
502479
cd polygene-check-rc
503-
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz
504-
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.MD5
505-
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.SHA-512
506-
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.asc
507-
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip
508-
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.MD5
509-
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.SHA-512
510-
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.asc
511480
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz
512481
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz.MD5
513482
wget https://dist.apache.org/repos/dist/dev/polygene/apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz.SHA-512
@@ -526,8 +495,6 @@ Verify PGP signatures:
526495
[source,shell]
527496
----
528497
cd polygene-check-rc
529-
gpg apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.asc
530-
gpg apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.asc
531498
gpg apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz.asc
532499
gpg apache-polygene-java-<RELEASE-VERSION>-RC#-src.zip.asc
533500
----
@@ -540,8 +507,6 @@ Verify MD5 checksum:
540507
[source,shell]
541508
----
542509
cd polygene-check-rc
543-
echo "$(cat apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.MD5) apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz" | md5sum -c -
544-
echo "$(cat apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.MD5) apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip" | md5sum -c -
545510
echo "$(cat apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz.MD5) apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz" | md5sum -c -
546511
echo "$(cat apache-polygene-java-<RELEASE-VERSION>-RC#-src.zip.MD5) apache-polygene-java-<RELEASE-VERSION>-RC#-src.zip" | md5sum -c -
547512
----
@@ -554,8 +519,6 @@ Verify SHA-512 checksum:
554519
[source,shell]
555520
----
556521
cd polygene-check-rc
557-
echo "$(cat apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.MD5) apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz" | shasum -a 512 -c -
558-
echo "$(cat apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.MD5) apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip" | shasum -a 512 -c -
559522
echo "$(cat apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz.MD5) apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz" | shasum -a 512 -c -
560523
echo "$(cat apache-polygene-java-<RELEASE-VERSION>-RC#-src.zip.MD5) apache-polygene-java-<RELEASE-VERSION>-RC#-src.zip" | shasum -a 512 -c -
561524
----
@@ -656,32 +619,6 @@ svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz.SHA-5
656619
svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-src.tgz.asc" \
657620
"$DIST_RELEASE_URL/apache-polygene-java-<RELEASE-VERSION>-src.tgz.asc" \
658621
-m "polygene: promoting release <RELEASE-VERSION> distributions"
659-
# Binary ZIP
660-
svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip" \
661-
"$DIST_RELEASE_URL/apache-polygene-java-<RELEASE-VERSION>-bin.zip" \
662-
-m "polygene: promoting release <RELEASE-VERSION> distributions"
663-
svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.MD5" \
664-
"$DIST_RELEASE_URL/apache-polygene-java-<RELEASE-VERSION>-bin.zip.MD5" \
665-
-m "polygene: promoting release <RELEASE-VERSION> distributions"
666-
svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.SHA-512" \
667-
"$DIST_RELEASE_URL/apache-polygene-java-<RELEASE-VERSION>-bin.zip.SHA-512" \
668-
-m "polygene: promoting release <RELEASE-VERSION> distributions"
669-
svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.zip.asc" \
670-
"$DIST_RELEASE_URL/apache-polygene-java-<RELEASE-VERSION>-bin.zip.asc" \
671-
-m "polygene: promoting release <RELEASE-VERSION> distributions"
672-
# Binary TAR.GZ
673-
svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz" \
674-
"$DIST_RELEASE_URL/apache-polygene-java-<RELEASE-VERSION>-bin.tgz" \
675-
-m "polygene: promoting release <RELEASE-VERSION> distributions"
676-
svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.MD5" \
677-
"$DIST_RELEASE_URL/apache-polygene-java-<RELEASE-VERSION>-bin.tgz.MD5" \
678-
-m "polygene: promoting release <RELEASE-VERSION> distributions"
679-
svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.SHA-512" \
680-
"$DIST_RELEASE_URL/apache-polygene-java-<RELEASE-VERSION>-bin.tgz.SHA-512" \
681-
-m "polygene: promoting release <RELEASE-VERSION> distributions"
682-
svn move "$DIST_DEV_URL/apache-polygene-java-<RELEASE-VERSION>-RC#-bin.tgz.asc" \
683-
"$DIST_RELEASE_URL/apache-polygene-java-<RELEASE-VERSION>-bin.tgz.asc" \
684-
-m "polygene: promoting release <RELEASE-VERSION> distributions"
685622
----
686623

687624
This produces one commit per file but keep svn history and runs fast, without re-uploading the distributions.
@@ -806,7 +743,7 @@ Register the new release at https://reporter.apache.org/[reporter.apache.org]
806743

807744
=== Announce
808745

809-
Finally, send an announcement to mailto:dev@polygene.apache.org[dev@] and mailto:users@polygene.apache.org[users@] mailing lists. Email announcements should have the subject line:
746+
Finally, send an announcement to mailto:dev@polygene.apache.org[dev@] mailing list. Email announcements should have the subject line:
810747

811748
[source,text]
812749
----
@@ -817,7 +754,7 @@ The announcement email should contains the release-notes as text, remember they
817754

818755

819756

820-
== VOTE fails
757+
== VOTE fails or is cancelled
821758

822759

823760
=== Record failure
@@ -846,9 +783,8 @@ Drop distributions, checksums and signatures from https://dist.apache.org/repos/
846783
[source,shell]
847784
----
848785
cd polygene-dist/dev/polygene/
849-
rm "*<RELEASE-VERSION>-RC#*.*"
850-
svn add * --force
851-
svn commit -m "polygene: dropping <RELEASE-VERSION>-RC# from dist/dev/polygene as the vote failed"
786+
svn rm "*<RELEASE-VERSION>-RC#*.*"
787+
svn commit -m "polygene: dropping <RELEASE-VERSION>-RC# from dist/dev/polygene as the vote failed/was cancelled"
852788
----
853789

854790
Drop NPM packages:

0 commit comments

Comments
 (0)