Introduction 

This documents the Apache UserALE.js release procedure. It is a living document; successive release managers will maintain it ensuring that all software packages are kept reasonably up-to-date and that good practice is followed and maintained with regards to the release procedure and resulting release artifacts. If there is something missing, feel free to comment or edit. Thank you, and let's get started.

Things you should read first:

Before we go any further, there is some good (potentially essential and a huge time saving practice) documentation on this topic. Please see the below links before going any further.

• http://apache.org/dev/#releases
• http://apache.org/dev/release-signing.html
• http://apache.org/dev/release-publishing.html

Release Prerequisites

• Create a new release in JIRA. If you do not already have privileges enabling you to do so, ask the SENSSOFT PMC.
• Push off all open issues to the next release; any critical or blocker issues should be resolved on mailing list. Discuss any issues that you are unsure of on the mailing list.

Apache releases are posted to dist.apache.org, which is a Subversion repository.

We have two directories here:

• https://dist.apache.org/repos/dist/release/incubator/senssoft - This is where PMC approved releases go. DO NOT UPLOAD here until we have a vote passed on dev@senssoft. Check out this folder and name it apache-dist-release-senssoft.

• https://dist.apache.org/repos/dist/dev/incubator/senssoft - this is where releases to be voted on go. Make the release artifact, post it here, and then post to the [VOTE] thread internally with the SensSoft community and over the general @incubator community. Check out this folder and name it apache-dist-dev-senssoft.

Example:

svn co https://dist.apache.org/repos/dist/release/incubator/senssoft apache-dist-release-senssoft
svn co https://dist.apache.org/repos/dist/dev/incubator/senssoft apache-dist-dev-senssoft

GPG Keys

The release manager must have a GPG key to be used to sign the release. See below to install gpg2 (with a gpgalias). The steps here also assume you have the following set (not using whoami if that’s not appropriate):

ASF_USERNAME=`whoami`
GPG_KEY=$ASF_USERNAME@apache.org
SVN_USERNAME=$ASF_USERNAME

Create a new GPG key giving your Apache email address, using gpg2 --gen-key then gpg2 --export-key $GPG_KEY > my-apache.key and gpg2 --export-secret-key -a $GPG_KEY > my-apache.private.key in the right directory (~/.ssh is a good one)

Look up your key fingerprint with gpg2 --fingerprint $GPG_KEY - it’s the long sequence of hex numbers separated by spaces. Log in to https://id.apache.org/ then copy-and-paste the fingerprint into “OpenPGP Public Key Primary Fingerprint”. Submit. 

Now add your key to the apache-dist-release-senssoft/KEYS file:

$ cd apache-dist-release-senssoft
$ (gpg2 --list-sigs $ASF_USERNAME@apache.org && gpg2 --armor --export $ASF_USERNAME@apache.org) >> KEYS
$ svn --username $SVN_USERNAME --no-auth-cache commit -m "Update senssoft/KEYS for $GPG_KEY"

Release Branch and Set Version

This will allow development to continue on master without affecting the release; it also allows quick-fixes to the release branch to address last-minute problems (which must of course be merged/cherry-picked back into master later). Do not use -rc1, -rc2 etc. in version strings. Use the version that will be the actual published version. (The artifacts that get uploaded to the dist.apache.org/dev will include “-rc1” etc. in the folder name, but the contents will be as final. Therefore, turning the rc into the final is simply a case of taking the rc file and publishing it to the release folder with the correct name.)

Create the release branch and set the release version number 

 As mentioned above, in UserALE.js we use NPM as a release management tool. This includes preparing and RC for a community VOTE.

• Make a clean checkout of the UserALE.js repository (ensuring that there are no local modifications): 

  $ git clone https://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs.git 
  $ git pull --rebase # assumes that the Apache canonical repository is the default upstream for your master - amend if necessary
  $ git checkout -b $VERSION_NAME

• Make sure all unit and integration tests are passing. 
  • All tests must pass... if they do not then they need to be fixed before further progress can be made. Each Senssoft subproject you are attempting to release should contain a README with details on how to run the tests. If it does not, submit a pull request before progressing.
• Update the CHANGELOG.md to reflect the current release, this may also be required for other essential files such as NOTICE, README etc. Ensure all of these files are accurate and up-to-date. It is also advised to include the JIRA release report in CHANGES.md. This makes it very easy for people to see the relevant changes for this release bundle.
• Now change the version numbers in this branch in package.json.

• If you have never made a SENSSOFT UserALE.js release, you are required to append your gpg key to the SENSSOFT KEYS file. This will then be used to sign all release artifacts. Much more about this can be found here http://apache.org/dev/release-signing.html

  This is an extremely important part of the release procedure. It is essential to get it right and that all subsequent release managers' KEYS are associated with this file.

• If any changes based on the above have been made, then commit them to the VERSION branch.

Update the version on master

The master branch will now need updating to refer to the next planned version. (This step is not required if making a “milestone” release or similar.) The release notes should be cleared out and the version history augmented with the new version. 

$ git add . && git commit -m "Change version to $NEW_MASTER_VERSION"

Switch back to the master branch

Move back to the release version.

$ git checkout $VERSION_NAME 

Making the release artifacts

The release script will:

1. Prepare a staging directory for the source code release
2. Create .tar.gz and .zip artifacts of the source code
3. Invoke npm to build the source code (including running unit tests), and deploy artifacts to a NPM remote repository
4. Save the .tar.gz and .zip artifacts produced by the build of senssoft-dist
5. For each of the produced files, produce MD5, SHA1, SHA256 and GnuPG signatures

At the end of the script, it will show you the files it has produced and their location.

Please note that the script will thoroughly clean the Git workspace of all uncommitted and unadded files even in dry run mode. Therefore you really want to run this against a secondary checkout. It will wipe .project files and other IDE metadata, and bad things can happen if an IDE tries to write while the script is running. Consider using the docker configuration provided.

The script has a single required parameter -r which is given the release candidate number - so -r1 will create release candidate 1 and will name the artifacts appropriately.

The script takes a -n parameter to work in dry run mode; in this mode, the script will NOT upload NPM artifacts or commit the release to the Subversion repository. This speeds up the process (the NPM deploy in particular slows down the build) and will catch any problems such as PGP or mocha problems much sooner.

# A dry run to test everything is OK
$ ./senssoft-dist/release/make-release-artifacts.sh -r$RC_NUMBER -n

# The real build, which will publish artifacts
$ ./senssoft-dist/release/make-release-artifacts.sh -r$RC_NUMBER

Once this has completed,

• navigate to http://repository.apache.org and log in.
• click on Staging Repositories on the left hand side, you should see the SENSSOFT RC staging profile.
• Select the profile and close the staging profile. This makes the artifacts available for people to tests and VOTE upon.

Push the source release artifacts and signatures to dist.apache.org as described below.

Check out SENSSOFT release staging area. The artifacts we push to this area are the ones we make available on official

Apache mirrors. These are therefore the sources artifacts we link to from the SENSSOFT site. e.g.

• svn co https://dist.apache.org/repos/dist/dev/incubator/SENSSOFT/

• In your local copy of SENSSOFT (master), navigate to $SENSSOFT/target directory and copy the src.zip and src-tar.gz artifacts along with relevant signatures to the above release staging directory.
• You should aim to include all relevant signatures along with these src artifacts. This would entail
  MD5, SHA and ASC signatures for each artifact. More information on this can be found here - http://apache.org/dev/release-signing.html
• copy the CHANGES.md to this directory as well
• finally, svn add all of the above artifacts and commit them to the SENSSOFT dev release staging area

Next, progress to the creation of the VOTE thread as below...

Verify the release artifacts

TBD

Publish to the staging area

Make a signed tag for this release candidate:

$ git tag -s -m "Tag release ${VERSION_NAME} release candidate ${RC_NUMBER}" rel/apache-senssoft-useralejs-${VERSION_NAME}-rc${RC_NUMBER}

$ git push userale-js $VERSION_NAME && git push apache-git rel/apache-senssoft-userale-js-${VERSION_NAME}-rc${RC_NUMBER}

$ mkdir apache-senssoft-useralejs-${VERSION_NAME}-rc${RC_NUMBER}

$ svn add apache-senssoft-useralejs-${VERSION_NAME}-rc${RC_NUMBER}
$ svn commit --username $SVN_USERNAME --no-auth-cache --message "Add apache-senssoft-useralejs-${VERSION_NAME}-rc${RC_NUMBER} to dist/dev/senssoft"

Close the staging repository on Apache’s Nexus server 

Closing the staging repository locks it from further changes, and provides a public URL for the repository that can be used for downloading the artifacts.

Go to the Apache Nexus server at https://repository.apache.org/ and log in using the link in the top right (the credentials are the same as your Git and Jenkins credentials). Go to the “Staging Repositories” page, and tick the repository with the name starting orgapachesenssoft. Click the Close button. Provide a description which includes the version and release candidate, e.g. Apache Senssoft UserAle.js 0.10.0-rc1.

Prepare the VOTE thread based on the artifacts

Send something like the following to the user@ and dev@SENSSOFT lists

To: "Apache SENSSOFT Developers List" <dev@SENSSOFT.incubator.apache.org>, "Apache SENSSOFT User List" <user@SENSSOFT.incubator.apache.org>
 Subject: VOTE Release Apache SENSSOFT (Incubating) X.Y

Hi Folks,
Please VOTE on the Apache SENSSOFT X.Y Release Candidate #Z.

We solved 44 issues: http://url/of/jira/release/report

Git source tag (c2d58dd1440b4e2c66c1f40a4b6d4169d79bb6d3): http://s.apache.org/Eyv

Staging repo: https://repository.apache.org/content/repositories/orgapacheSENSSOFT-1001

Source Release Artifacts: https://dist.apache.org/repos/dist/dev/SENSSOFT/X.Y/

PGP release keys (signed using 48BAEBF6): http://SENSSOFT.incubator.apache.org/dist/KEYS

Vote will be open for 72 hours.
Thank you to everyone that is able to VOTE as well as everyone that contributed to Apache SENSSOFT X.Y.

[ ] +1, let's get it released!!!
[ ] +/-0, fine, but consider to fix few issues before...
[ ] -1, nope, because... (and please explain why)

The above email includes the following

• A link to the JIRA Release Report... this is critical for making it explicit what was addressed in this particular 
  development drive.
• The SVN tag created by the mvn release plugin
• A link to the (closed) staging repository on repository.apache.org
• Link to the official release artifacts
• The KEYS file used containing developer signatures. This should be used to check signatures of release artifacts.

Double check the accuracy of this email and ship it to the masses!!!

N.B. DO NOT DELETE YOUR LOCAL COPY OF THE SENSSOFT RELEASE YOU"VE JUST PUSHED

IT IS ABSOLUTELY ESSENTIAL THAT YOU KEEP THE LOCAL RELEASE COPY !!!!

Preparing for new development

Send out the RESULT thread

After the 72 hours waiting time, it is down to the release manager to close the VOTE thread. This is usually

done by replying to the VOTE thread but changing the title to the following

Subject: [RELEASE] WAS:VOTE Release Apache SENSSOFT X.Y
The RESULT thread should basically tally up the VOTE's something like the following would do nicely
Hi Everyone, 
 As the 72 hours period has come and gone I would like to bring this thread to a close. 
The VOTE's have been counted and RESULT's are as follows 
 [7] +1, let's get it released!!! 
Tom
Dick
Harry 
Lewis John McGibbney * 
[0] +/-0, fine, but consider to fix few issues before... 
[0] -1, nope, because... (and please explain why) 
 *SENSSOFT PMC Binding VOTE 
 I'll progress with the remainder of the release procedure. 

If the release passes, progress to the next step, if not then head over to dev@SENSSOFT and discuss

how to revert the release. Assuming it passes however, progress to the next section.

Close the staging repos

Navigate to https://repository.apache.org and find the (closed) staging repos. Release this repository into

Apache Nexus. This will be pulled into Maven Central and in 12 or do hours the release artifacts should

be available at the following link - http://search.maven.org/#search%7Cga%7C1%7CSENSSOFT

Release the Source Artifacts

• svn mkdir https://dist.apache.org/repos/dist/dev/incubator/senssoft/useralejs
• svn cp https://dist.apache.org/repos/dist/dev/incubator/senssoft/useralejs to https://dist.apache.org/repos/dist/release/useralejs/X.Y/

Make sure that the up-to-date KEYS file exists in https://dist.apache.org/repos/dist/release/useralejs

Once all artifacts and signatures have been copied over, delete the dev area

• svn rm https://dist.apache.org/repos/dist/release/useralejs/X.Y/

The release artifacts will be copied over to apache.org/dist in due course and available for public download.

Release UserALE.js to NPM. 

Publish UserALE.js to NPM

1. Follow instructions on https://docs.npmjs.com/getting-started/publishing-npm-packages. Detailed below.

2. Use npm publish to publish the package. Note that everything in the directory will be included unless it is ignored by a local .gitignore or .npmignore file as described in npm-developers. Also make sure there isn't already a package with the same name, owned by somebody else. 

3. To Test: Go to https://npmjs.com/package/useralejs. The published contents are now available in NPM registry.

Update the Website to reflect the release

This can be done easily by editing the apache-senssoft page in the ASF project website.  To do this, update the relevant pages in the content folder of the asf/incubator-senssoft repo (http://git-wip-us.apache.org/repos/asf/incubator-senssoft) and commit the changes to the master branch.  Jenkins will rebuild the site within about half an hour, and you can observe your changes here: http://senssoft.incubator.apache.org/releases/.

It is important that all links on downloads.html are accurate including the signatures links. Also the PGP key reference to the signed artifacts should be updated to reflect the release managers KEY.

Apache UserALE.js 0.1.0 is now available:
- Source Code: [0]
- Downloads:  [1]
- NPM package: [2]
 
******* PGP key reference to signed artifacts needed ?? *******

UserALE.js uses the Apache Software License v2.0.  
 
----
For future releases, stay tuned and sign up for our mailing lists to keep up to date!
You can always find current SensSoft code in our git repositories [3], or on github [4].

 
[0] http://git-wip-us.apache.org/repos/asf/incubator-senssoft-user-ale [1] http://apache.org/dist/ [2] https://www.npmjs.com/package/useralejs
[3] http://incubator.apache.org/projects/senssoft.html [4] https://github.com/apache?q=senssoft

Announce the Release

Hi, The Apache SensSoft team are pleased to announce the immediate availability of Apache UserAle.js 0.1. 
The Apache UserALE.js is an open source tool to quickly and efficiently instrument a javascript frontend application. UserALE.js uses the Apache Software License v2.0. 
UserALE.js is released as both source code, downloads for which can be found at our releases page [0] as well as npm package which can be found on NPM [1]. 
This release addresses a modest XXXXX issues with ... blah blah blah. 
The full Jira release report can be found here [2]. 
Thank you Lewis (on behalf of SensSoft PMC) 
 
[0] http://senssoft.incubator.apache.org/releases/ [1] https://www.npmjs.com/package/useralejs [2] URL for Release Report in Jira

• Send an ANNOUNCEMENT to the following lists
  • Internal Apache Announcement list - announce@apache.org

Prepare for Next Development

• In the JIRA Administration Interface, go to
  • Versions
  • for the release tag you've just released, add a release date and then release it
• Update the DOAP to reflect the release