This is an automated email from the ASF dual-hosted git repository.
sergehuber pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/unomi-tracker.git
The following commit(s) were added to refs/heads/main by this push:
new 1273a51 Clarify that PMC votes approve the source release, not the
npm package.
1273a51 is described below
commit 1273a517c4667e9cc217cf38ba2c55084b0678ed
Author: Serge Huber <[email protected]>
AuthorDate: Mon Nov 16 12:30:25 2026 +0100
Clarify that PMC votes approve the source release, not the npm package.
Align RELEASE.md and release.sh with ASF policy and the Unomi vote mail
shape: the signed source is the release; the npm tarball is a convenience
binary rebuildable from that source.
---
RELEASE.md | 181 ++++++++++++++++++++++++++++++++++-------------------
scripts/release.sh | 126 ++++++++++++++++++++++---------------
2 files changed, 194 insertions(+), 113 deletions(-)
diff --git a/RELEASE.md b/RELEASE.md
index 5fd1b54..70b7b2f 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -29,6 +29,28 @@ Each release has a JIRA version, `unomi-tracker-X.Y.Z`, a
tag for each release c
both fix versions, and a pull request on each branch. Below, `X.Y.Z` is the
version being
released, for example `2.0.0`.
+What is released (ASF policy)
+-----------------------------
+Per the [ASF Release
Policy](https://www.apache.org/legal/release-policy.html), an Apache release
+**is the source package**. The PMC votes on that signed source. Binding +1
votes require downloading
+the signed source onto the voter's own machine, checking the signature and ASF
licensing rules,
+building it, and testing the result
+(https://www.apache.org/legal/release-policy.html#release-approval).
+
+| Artifact | Role |
+|---|---|
+| `unomi-tracker-X.Y.Z.tar.gz` | **Official source release** (what the vote
approves) |
+| `apache-unomi-tracker-X.Y.Z.tgz` | **Convenience binary** (`npm pack` of
that source): same version, only build output from compiling that source;
optional for users who do not rebuild. Not what binding votes are cast on. |
+
+The convenience package MAY be staged, signed, moved to `dist/release`, and
published to npm after
+the source vote passes. The PMC remains responsible for every artifact under
the project's
+`downloads.apache.org` tree, so the binary must still match the voted source
(rebuildable with
+`npm pack` from that source). See also
+[Release Distribution
Policy](https://infra.apache.org/release-distribution.html) (“convenience
+binaries” / PMC-approved artifacts) and the Unomi
+[release guide](https://unomi.apache.org/contribute/release-guide.html)
(source vs convenience
+binaries on Nexus).
+
`scripts/release.sh` runs the checks and steps below, on macOS or Linux; each
one that others see
(`git push`, `svn`, `npm publish`) asks first, and `--dry-run` skips them. Its
files go to
`target/release/`. It needs `bash`, `git`, `gpg`, `node`, `yarn`, `npm`,
`curl`, `svn`, `java` (for
@@ -38,11 +60,15 @@ said below. The packages it builds are the same on macOS
and Linux, with Node 20
| Stage | Command |
|---|---|
| Before the release | `scripts/release.sh check X.Y.Z --key <id> [--servers]
[--safari]` |
-| A release candidate | `scripts/release.sh candidate X.Y.Z N --key <id>
[--servers] [--safari]` |
+| A release candidate | `scripts/release.sh candidate X.Y.Z N --key <id>
[--servers] [--safari] [--dry-run]` |
| A voter's checks | `scripts/release.sh verify X.Y.Z N [--servers]` |
-| After the vote | `scripts/release.sh publish X.Y.Z N --key <id>` |
-| Once the download page links to it | `scripts/release.sh finish X.Y.Z` |
-| After a failed vote | `scripts/release.sh abandon X.Y.Z N` |
+| After the vote | `scripts/release.sh publish X.Y.Z N --key <id> [--dry-run]`
|
+| Once the download page links to it | `scripts/release.sh finish X.Y.Z
[--dry-run]` |
+| After a failed vote | `scripts/release.sh abandon X.Y.Z N [--dry-run]` |
+
+`--dry-run` builds and checks the packages, and writes the emails under
`target/release/`, but
+skips every step others see (`git push`, `svn`, `npm publish`). Use it to
rehearse a candidate
+before the real cut.
Each command checks what the step before it should have done, and stops if it
is not: `candidate`
runs the checks of `check`, takes the next candidate number only, and only
once the previous
@@ -62,11 +88,12 @@ README say; `--servers` and `--safari` run the last two
checks.
for a 2.x release).
- `NOTICE` has the current year.
- The licensing is right
(https://www.apache.org/legal/release-policy.html#licensing):
- `LICENSE` and `NOTICE` describe exactly what each package contains. The
source package has
- `LICENSE` (the Apache License). The npm package bundles third-party code in
its browser build, so
- it has `LICENSE-binary` as its `LICENSE`, which also lists those components
(`npm pack` puts it in
- place, see `scripts/npm-license.js`; `yarn test` checks that it matches the
build). Every bundled
- component has a license of category A
(https://www.apache.org/legal/resolved.html).
+ `LICENSE` and `NOTICE` describe exactly what each package contains. The
**source** package has
+ `LICENSE` (the Apache License). The **convenience** npm package bundles
third-party code in its
+ browser build, so it has `LICENSE-binary` as its `LICENSE`, which also lists
those components
+ (`npm pack` puts it in place, see `scripts/npm-license.js`; `yarn test`
checks that it matches
+ the build). Every bundled component has a license of category A
+ (https://www.apache.org/legal/resolved.html).
- Every source file has the ASF license header. This lists the files without
it (the result must
be empty):
```shell
@@ -98,16 +125,18 @@ The release candidate
Each release candidate has a number, `N`, from 1: `rcN` below.
`scripts/release.sh candidate X.Y.Z N --key <id>` does all of this, checks the
packages as
`verify` does, and writes the vote email to
`target/release/X.Y.Z-rcN/vote-email.txt`. `verify`
-also checks that the source package is the content of the tag, and that the
tag is signed by a key
-of the KEYS.
+checks the **source** package (signature, tag contents, licensing, build and
tests). It also
+checks that `npm pack` on that source rebuilds the staged convenience `.tgz`
(same checksum), so
+the binary is demonstrably from the source under vote — that is an RM/voter
convenience check, not
+a separate vote on the binary.
- `package.json` has the version `X.Y.Z`.
- Tag and push the candidate: `git tag -s -u <your key id> vX.Y.Z-rcN -m
'Release candidate N of X.Y.Z'`,
then `git push origin vX.Y.Z-rcN`. Give your Apache key explicitly: without
`-u`, git signs with
`user.signingkey`, which can be another key (for example the one that signs
your commits). The
tag of a candidate is never moved or deleted: a new candidate gets a new tag.
-- The source package, from the tag, then the npm package built from it, each
signed and with its
- checksum:
+- The **source** package from the tag, then the **convenience** npm package
built from it
+ (`npm pack`), each signed and with its checksum:
```shell
git archive --format=tar.gz --prefix=unomi-tracker-X.Y.Z/ -o
unomi-tracker-X.Y.Z.tar.gz vX.Y.Z-rcN
tar xzf unomi-tracker-X.Y.Z.tar.gz && cd unomi-tracker-X.Y.Z
@@ -118,77 +147,100 @@ of the KEYS.
gpg -ab -u <your key id> $f && gpg --verify $f.asc $f && shasum -a 512 $f
> $f.sha512
done
```
- Check that the signatures use your Apache key, and that the npm package has
`dist`, `NOTICE`,
- `KEYS`, and as `LICENSE` the content of `LICENSE-binary` (`tar tzf
apache-unomi-tracker-X.Y.Z.tgz`).
- The npm package is the one published after the vote: voters check it too.
The build is
- reproducible, so `npm pack` on the same source gives the same file, with the
same checksum.
+ Check that the signatures use your Apache key. For the convenience package,
check that it has
+ `dist`, `NOTICE`, `KEYS`, and as `LICENSE` the content of `LICENSE-binary`
+ (`tar tzf apache-unomi-tracker-X.Y.Z.tgz`). The build is reproducible: `npm
pack` on the same
+ source gives the same file and checksum.
- Upload the six files to
https://dist.apache.org/repos/dist/dev/unomi/unomi-tracker/X.Y.Z-rcN/
- (create the folder).
+ (create the folder). The source tarball is the release candidate; the `.tgz`
is the convenience
+ binary staged with it.
The vote
--------
-Send the vote to [email protected] (`candidate` writes it; add what the
release brings); it lasts at least 72 hours, and needs at least three +1
-votes from PMC members (binding), and more binding +1 than -1 votes
-(https://www.apache.org/legal/release-policy.html#release-approval). Before a
+1, voters download
-the packages to their own machine, check their signatures and checksums, their
licensing, and build
-and test the source package there. For example:
+Send the vote to [email protected] (`candidate` writes it; add what the
release brings from
+`CHANGES.md`). The mail shape follows the Unomi server vote template in the
+[release guide](https://unomi.apache.org/contribute/release-guide.html)
(submit / **source**
+staging / tag / release notes / 72 hours / binding +1). Tracker staging is
under
+`dist/dev/unomi/unomi-tracker/` (not Nexus). **The vote approves the source
release.** Convenience
+binaries may be listed for inspection but are not what binding votes are cast
on.
+
+The vote lasts at least 72 hours, and needs at least three +1 votes from PMC
members (binding), and
+more binding +1 than -1 votes
(https://www.apache.org/legal/release-policy.html#release-approval).
+Before a binding +1, voters **MUST** download the signed **source** package
onto their own machine,
+validate the cryptographic signature, confirm ASF licensing requirements,
compile as provided, and
+test the result on their own platform. For example:
```
-Subject: [VOTE] Release Apache Unomi tracker X.Y.Z (release candidate N)
+Subject: [VOTE] Apache Unomi tracker X.Y.Z release (RCN)
Hi all,
-I would like to release Apache Unomi tracker X.Y.Z, the JavaScript tracker for
Apache Unomi.
-<One or two sentences on what the release brings, from CHANGES.md.>
+I submit Apache Unomi tracker X.Y.Z release candidate N to your vote.
-Release notes:
-https://github.com/apache/unomi-tracker/blob/vX.Y.Z-rcN/CHANGES.md
-JIRA:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319220&version=<version
id>
+Apache Unomi tracker is the JavaScript library that websites use to send
visitors' events to
+Apache Unomi and to personalize pages with its answers.
+
+<What the release brings, from CHANGES.md: a short list of major changes and
why they matter.>
-Source package and npm package, with their signatures and checksums:
+Source release (what this vote approves), with signature and checksum:
+https://dist.apache.org/repos/dist/dev/unomi/unomi-tracker/X.Y.Z-rcN/unomi-tracker-X.Y.Z.tar.gz
https://dist.apache.org/repos/dist/dev/unomi/unomi-tracker/X.Y.Z-rcN/
-Tag: https://github.com/apache/unomi-tracker/releases/tag/vX.Y.Z-rcN (commit
<sha>)
+Git tag:
+vX.Y.Z-rcN (commit <sha>)
+https://github.com/apache/unomi-tracker/releases/tag/vX.Y.Z-rcN
+
+Release notes:
+https://github.com/apache/unomi-tracker/blob/vX.Y.Z-rcN/CHANGES.md
+https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319220&version=<version
id>
Signing keys: https://downloads.apache.org/unomi/KEYS
-To check the packages, on your own machine, from a checkout of the tag:
+Convenience binary (not subject to this vote; built from the source above with
npm pack, for users
+who do not rebuild; published to npm after the source vote passes):
+https://dist.apache.org/repos/dist/dev/unomi/unomi-tracker/X.Y.Z-rcN/apache-unomi-tracker-X.Y.Z.tgz
+
+To verify the source release, on your own machine, from a checkout of the tag:
scripts/release.sh verify X.Y.Z N
-It checks the signatures and checksums with the KEYS above, the licensing
(LICENSE, NOTICE,
-headers, Apache RAT), builds and tests the source package, and checks that npm
pack on it gives
-the npm package above, byte for byte. Add --servers for the tests against
Unomi servers (Docker).
-Or by hand:
+It checks the source signature and checksum with the KEYS above, that the
source package is the
+tag's content and the tag is signed, the licensing (LICENSE, NOTICE, headers,
Apache RAT), builds
+and tests the source, and (optionally useful) that npm pack on that source
rebuilds the staged
+convenience .tgz. Add --servers for the tests against Unomi servers (Docker).
+Or by hand (binding +1 requires at least the source steps):
gpg --import KEYS
gpg --verify unomi-tracker-X.Y.Z.tar.gz.asc unomi-tracker-X.Y.Z.tar.gz
- gpg --verify apache-unomi-tracker-X.Y.Z.tgz.asc
apache-unomi-tracker-X.Y.Z.tgz
- shasum -a 512 -c unomi-tracker-X.Y.Z.tar.gz.sha512
apache-unomi-tracker-X.Y.Z.tgz.sha512
+ shasum -a 512 -c unomi-tracker-X.Y.Z.tar.gz.sha512
(or sha512sum -c, on Linux without shasum)
-then untar the source package, check LICENSE and NOTICE, and run yarn install
--frozen-lockfile,
-yarn test and npm pack: the npm package it builds has the same checksum as the
one above. The tests
-against Unomi servers need Docker: yarn test:servers.
-
-The npm package is the one published to npm after the vote.
+then untar the source package, check LICENSE and NOTICE, and run yarn install
--frozen-lockfile
+and yarn test. The tests against Unomi servers need Docker: yarn test:servers.
-The vote is open for at least 72 hours.
+Please vote to approve this source release:
-[ ] +1 Release these packages as Apache Unomi tracker X.Y.Z
+[ ] +1 Approve the release
[ ] +0 No opinion
-[ ] -1 Do not release these packages because...
+[ ] -1 Don't approve the release (please provide specific comments)
+
+This vote will be open for at least 72 hours, or until the necessary number of
binding votes
+(3 +1) is reached.
+
+Please let me know if you have any questions.
Thanks,
<name>
```
-Send the result to the same list, with `[RESULT][VOTE]` in the subject, and
the votes counted
-(binding and non-binding). If the vote fails, remove the candidate's folder
from `dist/dev`
-(`svn rm https://dist.apache.org/repos/dist/dev/unomi/unomi-tracker/X.Y.Z-rcN
-m "..."`), fix the
-problems, and start again with the next candidate, `rcN+1`. Keep the failed
candidate's tag.
+Send the result to the same list (`publish` writes a draft), with
`[RESULT][VOTE]` in the subject,
+and the votes counted (binding and non-binding), in the same shape as the
Unomi server result mail.
+If the vote fails, remove the candidate's folder from `dist/dev`
+(`scripts/release.sh abandon X.Y.Z N`, or `svn rm` by hand), fix the problems,
and start again with
+the next candidate, `rcN+1`. Keep the failed candidate's tag.
After the vote
--------------
`scripts/release.sh publish X.Y.Z N --key <id>` checks the vote (72 hours, and
the binding votes it
-asks for), writes the result email to `target/release/X.Y.Z/result-email.txt`,
tags, moves, checks
-and publishes the npm package, checks that npm serves the voted file, writes
the announcement to
+asks for), writes the result email to `target/release/X.Y.Z/result-email.txt`,
tags, moves the
+**source** and the convenience binary to `dist/release`, publishes the
convenience `.tgz` to npm
+(same bytes as staged, no rebuild), checks that npm serves that file, writes
the announcement to
`target/release/X.Y.Z/announce-email.txt`, and says what to do by hand: JIRA
and
reporter.apache.org, then the download page, from one hour after the move. Then
`scripts/release.sh finish X.Y.Z` checks downloads.apache.org, the download
page and JIRA, removes
@@ -201,10 +253,12 @@ removes the candidate from `dist/dev`.
`git push origin vX.Y.Z`.
- Move the packages: `svn mv
https://dist.apache.org/repos/dist/dev/unomi/unomi-tracker/X.Y.Z-rcN
https://dist.apache.org/repos/dist/release/unomi/unomi-tracker/X.Y.Z -m
"Apache Unomi tracker X.Y.Z
- release"` (a PMC member does it).
+ release"` (a PMC member does it). This publishes the official source release
(and the convenience
+ binary staged with it) on `downloads.apache.org`.
- In JIRA, mark `unomi-tracker-X.Y.Z` as released, with the date, and record
the release on
https://reporter.apache.org/addrelease.html?unomi
-- Publish to npm the npm package that was voted, after checking it:
+- Publish to npm the **convenience** package built from the voted source
(staged `.tgz`), after
+ checking its signature and checksum:
```shell
curl -O
https://dist.apache.org/repos/dist/release/unomi/unomi-tracker/X.Y.Z/apache-unomi-tracker-X.Y.Z.tgz
curl -O
https://dist.apache.org/repos/dist/release/unomi/unomi-tracker/X.Y.Z/apache-unomi-tracker-X.Y.Z.tgz.asc
@@ -213,8 +267,9 @@ removes the candidate from `dist/dev`.
shasum -a 512 -c apache-unomi-tracker-X.Y.Z.tgz.sha512
npm publish apache-unomi-tracker-X.Y.Z.tgz
```
- Publishing the file publishes it as it is, without building anything. For a
1.x release once 2.x
- is published, use `npm publish --tag latest-1
apache-unomi-tracker-X.Y.Z.tgz`, so that
+ Publishing the file publishes it as it is, without building anything. npm is
a downstream
+ convenience channel, not the ASF official distribution of the source
release. For a 1.x release
+ once 2.x is published, use `npm publish --tag latest-1
apache-unomi-tracker-X.Y.Z.tgz`, so that
`npm install apache-unomi-tracker` keeps installing 2.x.
- Wait at least one hour after the move, so that https://downloads.apache.org
has the release,
then update the Unomi download page
(https://unomi.apache.org/download.html): in the
@@ -232,22 +287,22 @@ removes the candidate from `dist/dev`.
recommended. For example:
```
- Subject: [ANNOUNCE] Apache Unomi tracker X.Y.Z released
+ Subject: [ANNOUNCE] Apache Unomi tracker X.Y.Z Release
- The Apache Unomi team is pleased to announce the release of Apache Unomi
tracker X.Y.Z.
+ The Apache Unomi team would like to announce the release of Apache Unomi
tracker X.Y.Z.
Apache Unomi tracker is the JavaScript library that websites use to send
their visitors' events
to Apache Unomi, a customer data platform, and to personalize their pages
with its answers.
<What the release brings, in a few lines, from CHANGES.md.>
- Download: https://unomi.apache.org/download.html
- npm: npm install [email protected]
+ Source download: https://unomi.apache.org/download.html
+ Convenience package (npm): npm install [email protected]
Release notes: https://github.com/apache/unomi-tracker/blob/vX.Y.Z/CHANGES.md
+ JIRA:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319220&version=<version
id>
- Thanks to everyone who contributed to this release.
-
- <name>, on behalf of the Apache Unomi PMC
+ Thanks!
+ The Apache Unomi Team
```
- Update the tracker that Unomi bundles
(`extensions/web-tracker/wab/package.json` in
https://github.com/apache/unomi) to the released version.
diff --git a/scripts/release.sh b/scripts/release.sh
index 0014a2b..eabda30 100755
--- a/scripts/release.sh
+++ b/scripts/release.sh
@@ -23,15 +23,16 @@
# scripts/release.sh check X.Y.Z --key <id> [--servers] [--safari]
# The checks before a release, on this checkout (candidate runs them
too).
# scripts/release.sh candidate X.Y.Z N --key <id> [--servers] [--safari]
[--dry-run]
-# Release candidate N: the checks, the source and npm packages built
from HEAD, signed and
-# checked as voters will, then the tag vX.Y.Z-rcN on that commit, the
files staged in
-# dist/dev, and the vote email. Run again after a failure, it goes on
where it stopped.
+# Release candidate N: the checks, the source release and convenience
npm package built from
+# HEAD, signed and checked, then the tag vX.Y.Z-rcN on that commit, the
files staged in
+# dist/dev, and the vote email (vote is on the source). Run again after
a failure, it goes on
+# where it stopped.
# scripts/release.sh verify X.Y.Z N [--dir <folder>] [--servers]
-# What a voter checks, on the staged candidate (or on the files in
<folder>).
+# What a voter checks for a binding +1: the signed source (and useful
rebuild checks).
# scripts/release.sh publish X.Y.Z N --key <id> [--plus <n> --minus <n>]
[--dry-run]
# After the vote: checks it lasted 72 hours and passed (the binding
votes, asked), the result
-# email, the tag vX.Y.Z, the move to dist/release, the voted npm package
published as it is
-# and compared with what npm serves, and the announcement email.
+# email, the tag vX.Y.Z, the move to dist/release, the convenience npm
package published as
+# staged and compared with what npm serves, and the announcement email.
# scripts/release.sh finish X.Y.Z [--dry-run]
# Once downloads.apache.org has the release, the download page links to
it, and JIRA has it
# released: removes the previous release of the line from dist/release,
and what is left.
@@ -272,9 +273,9 @@ check_source_package() {
check_npm_package "$version" "$built" "$dir"
if [ -n "$npm_package" ]; then
if cmp -s "$built" "$npm_package"; then
- ok "npm pack on the source package gives the staged npm package,
byte for byte"
+ ok "npm pack on the source rebuilds the staged convenience
package, byte for byte"
else
- fail "npm pack on the source package does not give the staged npm
package: the build is not reproducible, or the npm package is not built from
this source"
+ fail "npm pack on the source does not give the staged convenience
package: the build is not reproducible, or the .tgz is not built from this
source"
fi
fi
BUILT_NPM_PACKAGE=$built
@@ -591,49 +592,62 @@ cmd_candidate() {
write_vote_email() {
local version=$1 rc=$2 sha=$3 jira_id=$4
+ # Vote is on the source release (ASF policy). Convenience binary is listed
separately.
cat <<EOF
To: [email protected]
-Subject: [VOTE] Release Apache Unomi tracker $version (release candidate $rc)
+Subject: [VOTE] Apache Unomi tracker $version release (RC$rc)
Hi all,
-I would like to release Apache Unomi tracker $version, the JavaScript tracker
for Apache Unomi.
-<One or two sentences on what the release brings, from CHANGES.md.>
+I submit Apache Unomi tracker $version release candidate $rc to your vote.
-Release notes:
-https://github.com/apache/unomi-tracker/blob/v$version-rc$rc/CHANGES.md
-JIRA: $JIRA/secure/ReleaseNote.jspa?projectId=$JIRA_PROJECT_ID&version=$jira_id
+Apache Unomi tracker is the JavaScript library that websites use to send
visitors' events to
+Apache Unomi and to personalize pages with its answers.
+
+<What the release brings, from CHANGES.md: a short list of major changes and
why they matter.>
-Source package and npm package, with their signatures and checksums:
+Source release (what this vote approves), with signature and checksum:
+$DIST_DEV/$version-rc$rc/unomi-tracker-$version.tar.gz
$DIST_DEV/$version-rc$rc/
-Tag: https://github.com/apache/unomi-tracker/releases/tag/v$version-rc$rc
(commit $sha)
+Git tag:
+v$version-rc$rc (commit $sha)
+https://github.com/apache/unomi-tracker/releases/tag/v$version-rc$rc
+
+Release notes:
+https://github.com/apache/unomi-tracker/blob/v$version-rc$rc/CHANGES.md
+$JIRA/secure/ReleaseNote.jspa?projectId=$JIRA_PROJECT_ID&version=$jira_id
Signing keys: $KEYS_URL
-To check the packages, on your own machine, from a checkout of the tag:
+Convenience binary (not subject to this vote; built from the source above with
npm pack, for users
+who do not rebuild; published to npm after the source vote passes):
+$DIST_DEV/$version-rc$rc/$NPM_PACKAGE-$version.tgz
+
+To verify the source release, on your own machine, from a checkout of the tag:
scripts/release.sh verify $version $rc
-It checks the signatures and checksums with the KEYS above, that the source
package is the tag's
-content and the tag is signed, the licensing (LICENSE, NOTICE, headers, Apache
RAT), builds and
-tests the source package, and checks that npm pack on it gives the npm package
above, byte for
-byte. Add --servers for the tests against Unomi servers (Docker).
-Or by hand:
+It checks the source signature and checksum with the KEYS above, that the
source package is the
+tag's content and the tag is signed, the licensing (LICENSE, NOTICE, headers,
Apache RAT), builds
+and tests the source, and (optionally useful) that npm pack on that source
rebuilds the staged
+convenience .tgz. Add --servers for the tests against Unomi servers (Docker).
+Or by hand (binding +1 requires at least the source steps):
gpg --import KEYS
gpg --verify unomi-tracker-$version.tar.gz.asc unomi-tracker-$version.tar.gz
- gpg --verify $NPM_PACKAGE-$version.tgz.asc $NPM_PACKAGE-$version.tgz
- shasum -a 512 -c unomi-tracker-$version.tar.gz.sha512
$NPM_PACKAGE-$version.tgz.sha512
+ shasum -a 512 -c unomi-tracker-$version.tar.gz.sha512
(or sha512sum -c, on Linux without shasum)
-then untar the source package, check LICENSE and NOTICE, and run yarn install
--frozen-lockfile,
-yarn test and npm pack: the npm package it builds has the same checksum as the
one above.
+then untar the source package, check LICENSE and NOTICE, and run yarn install
--frozen-lockfile
+and yarn test.
-The npm package is the one published to npm after the vote.
+Please vote to approve this source release:
-The vote is open for at least 72 hours, and passes with at least three binding
+1 votes and more
-binding +1 than -1 votes.
-
-[ ] +1 Release these packages as Apache Unomi tracker $version
+[ ] +1 Approve the release
[ ] +0 No opinion
-[ ] -1 Do not release these packages because...
+[ ] -1 Don't approve the release (please provide specific comments)
+
+This vote will be open for at least 72 hours, or until the necessary number of
binding votes
+(3 +1) is reached.
+
+Please let me know if you have any questions.
Thanks,
<name>
@@ -776,7 +790,7 @@ cmd_publish() {
ok "moved to $DIST_RELEASE/$version/"
fi
- step "Publish the voted npm package"
+ step "Publish the convenience npm package (built from the voted source)"
local from=$DIST_RELEASE/$version
svn info "$from" >/dev/null 2>&1 || from=$DIST_DEV/$version-rc$rc
local file="$NPM_PACKAGE-$version.tgz" suffix
@@ -790,7 +804,7 @@ cmd_publish() {
integrity=$(npm_integrity "$work/$file")
published=$(npm view "$NPM_PACKAGE@$version" dist.integrity 2>/dev/null ||
true)
if [ -n "$published" ]; then
- [ "$published" = "$integrity" ] && ok "$NPM_PACKAGE@$version is on
npm, and is the voted package" || fail "$NPM_PACKAGE@$version is on npm, but is
not the voted package"
+ [ "$published" = "$integrity" ] && ok "$NPM_PACKAGE@$version is on
npm, and matches the staged convenience package" || fail "$NPM_PACKAGE@$version
is on npm, but does not match the staged convenience package"
else
# A release of an older line than npm's latest keeps latest: 1.x is
published as latest-1
local latest major tag_args=()
@@ -802,7 +816,7 @@ cmd_publish() {
if confirm "npm publish ${tag_args[*]+${tag_args[*]} }$file (npm's
latest is ${latest:-none})?"; then
npm publish "${tag_args[@]+"${tag_args[@]}"}" "$work/$file"
published=$(npm view "$NPM_PACKAGE@$version" dist.integrity
2>/dev/null || true)
- [ "$published" = "$integrity" ] && ok "npm has
$NPM_PACKAGE@$version, and it is the voted package" || fail "npm does not give
the voted package for $NPM_PACKAGE@$version (integrity ${published:-none})"
+ [ "$published" = "$integrity" ] && ok "npm has
$NPM_PACKAGE@$version, matching the staged convenience package" || fail "npm
does not give the staged convenience package for $NPM_PACKAGE@$version
(integrity ${published:-none})"
fi
fi
@@ -824,45 +838,57 @@ EOF
write_result_email() {
local version=$1 rc=$2 plus=$3 minus=$4
+ # Same shape as the Unomi server [RESULT][VOTE] mail in the release guide.
cat <<EOF
To: [email protected]
-Subject: [RESULT][VOTE] Release Apache Unomi tracker $version (release
candidate $rc)
+Subject: [RESULT][VOTE] Apache Unomi tracker $version release (RC$rc)
-Hi all,
+Hi,
+
+Thank you for your votes.
+
+Here's the summary:
-The vote to release Apache Unomi tracker $version (release candidate $rc)
passes, with:
+$plus binding +1:
+<names>
-$plus binding +1: <names>
-<n> non-binding +1: <names>
-<n> +0: <names>
-$minus binding -1: <names>
+<n> non-binding +1:
+<names>
-Thanks to everyone who checked the release candidate and voted. I will now
publish the release.
+<n> +0:
+<names>
+$minus binding -1:
+<names>
+
+The proposal to release Apache Unomi tracker $version is approved by the team.
+
+Thanks,
<name>
EOF
}
write_announcement() {
local version=$1
+ # Same shape as the Unomi server announce template; source download first,
npm as convenience.
cat <<EOF
To: [email protected], [email protected], [email protected]
-Subject: [ANNOUNCE] Apache Unomi tracker $version released
+Subject: [ANNOUNCE] Apache Unomi tracker $version Release
-The Apache Unomi team is pleased to announce the release of Apache Unomi
tracker $version.
+The Apache Unomi team would like to announce the release of Apache Unomi
tracker $version.
Apache Unomi tracker is the JavaScript library that websites use to send their
visitors' events
to Apache Unomi, a customer data platform, and to personalize their pages with
its answers.
<What the release brings, in a few lines, from CHANGES.md.>
-Download: https://unomi.apache.org/download.html
-npm: npm install $NPM_PACKAGE@$version
+Source download: https://unomi.apache.org/download.html
+Convenience package (npm): npm install $NPM_PACKAGE@$version
Release notes:
https://github.com/apache/unomi-tracker/blob/v$version/CHANGES.md
+JIRA:
$JIRA/secure/ReleaseNote.jspa?projectId=$JIRA_PROJECT_ID&version=$(jira_version_id
"$version")
-Thanks to everyone who contributed to this release.
-
-<name>, on behalf of the Apache Unomi PMC
+Thanks!
+The Apache Unomi Team
EOF
}