Producing a release candidate

Tag the release candidate

Once the release process has begun and the release has been thoroughly tested, the git repositories must be tagged for a new release candidate. These tags are made off the release branch (not off master), and are in the format [VERSION]-RC[N], where [VERSION] is the version of the upcoming release and [N] is the number of the release candidate:

$ git tag -m "Release 0.9.11-incubating - RC1." 0.9.11-incubating-RC1
$ git push upstream 0.9.11-incubating-RC1

Each repository relevant to the release must be tagged. At this point, this will be every repository that has a release branch. This never includes incubator-guacamole-website, which is not part of the release.

Example: the “0.9.10-incubating-RC3” tag on incubator-guacamole-server

Sign and upload release artifacts

Create and sign release artifacts for all modified components, uploading to Apache’s dev dist via SVN (NOT the release dist), grouping the artifacts within binary/ and source/ subdirectories of a top-level, RC-specific subdirectory (named in the same [VERSION]-RC[N] format as the repository tag).

Creating the source and binary artifacts involves building the components of Guacamole normally. The process for producing signatures and uploading the artifacts will depend on whether the artifacts are being deployed to a Maven repository.

If your PGP key is not already present in the KEYS file, you will need to add it prior to signing artifacts.

Normal source / binary artifacts

There are currently two source artifacts:

guacamole-client-[VERSION].tar.gz is created automatically when incubator-guacamole-client is built with mvn clean install. guacamole-server-[VERSION].tar.gz can be built manually by running make dist within incubator-guacamole-server. The Makefile, etc. will need to have been generated first by running autoreconf -fi followed by ./configure.

incubator-guacamole-server does not provide any convenience binaries, but incubator-guacamole-client does:

Each of the above can be found within the incubator-guacamole-client source tree once it has been built with mvn clean install.

Producing the required MD5 and SHA256 checksums for a given artifact is very straightforward:

$ md5sum FILENAME > FILENAME.md5
$ sha256sum FILENAME > FILENAME.sha

To produce the PGP signature for a given artifact, use gpg, as documented in Apache’s own release signing documentation:

$ gpg --armor --output FILENAME.asc --detach-sig FILENAME

Example: the SVN commit uploading RC1 of 0.9.10-incubating (r17053)

Maven artifacts

The following Maven subprojects of incubator-guacamole-client must be uploaded to Apache’s Nexus:

Uploading to Apache’s Nexus repository requires that your username and password be stored within your Maven ~/.m2/settings.xml:

<settings>
    <servers>
        <server>
            <id>apache</id>
            <username>YOUR-USERNAME</username>
            <password>YOUR-PASSWORD</password>
        </server>
    </servers>
</settings>

The ID of the server is arbitrary but must match the repositoryId value given to Maven. The examples here use apache. Most artifacts are Java .jar files with corresponding JavaDoc and source jars. Each of these must be signed and uploaded individually using the gpg:sign-and-deploy-file mojo:

$ mvn gpg:sign-and-deploy-file \
    -Durl=https://repository.apache.org/service/local/staging/deploy/maven2 \
    -DrepositoryId=apache -DpomFile=guacamole-common/pom.xml \
    -Dfile=guacamole-common/target/guacamole-common-0.9.10-incubating.jar

$ mvn gpg:sign-and-deploy-file \
    -Durl=https://repository.apache.org/service/local/staging/deploy/maven2 \
    -DrepositoryId=apache -DpomFile=guacamole-common/pom.xml \
    -Dfile=guacamole-common/target/guacamole-common-0.9.10-incubating-javadoc.jar \
    -Dclassifier=javadoc

$ mvn gpg:sign-and-deploy-file \
    -Durl=https://repository.apache.org/service/local/staging/deploy/maven2 \
    -DrepositoryId=apache -DpomFile=guacamole-common/pom.xml \
    -Dfile=guacamole-common/target/guacamole-common-0.9.10-incubating-sources.jar \
    -Dclassifier=sources

The above will need to be done for both guacamole-common and guacamole-ext, assuming both have been modified for the release. For JavaScript artifacts like guacamole-common-js which produce a single .zip file, only the .zip file needs to be uploaded. The command for this is slightly different:

$ mvn gpg:sign-and-deploy-file \
    -Durl=https://repository.apache.org/service/local/staging/deploy/maven2 \
    -DrepositoryId=apache \
    -DpomFile=guacamole-common-js/pom.xml \
    -Dfile=guacamole-common-js/target/guacamole-common-js-0.9.10-incubating.zip \
    -Dpackaging=zip

Once everything has been uploaded, log into Apache’s Nexus at https://repository.apache.org/, locate the staging repository which was automatically created, and verify things look as expected. Assuming everything looks good, select close staging repository to make it publicly available; the URL of the repository will need to be provided in the various VOTE emails.

Docker images

Both guacamole-client and guacamole-server have associated Docker images which are produced along with releases as a form of convenience binaries. These images are guacamole/guacamole and guacamole/guacd respectively, both hosted under the Apache Guacamole project’s Docker Hub account.

When building the Docker images, keep in mind:

  1. You should run git clean -xfd . first, to ensure the build context uploaded to the Docker daemon is minimal, and that future builds of the exact same source will not result in different images (this serves as a pre-release sanity check).
  2. You MUST NOT update the latest tag on Docker Hub, as this must only point to the latest stable release.
  3. When building a Docker image with the intent of pushing to a specific tag, the Docker image must be built with that tag.

For example, to build the guacamole/guacamole Docker image for the current release candidate, from within the top-level incubator-guacamole-client directory:

$ git clean -xfd .
$ sudo docker build -t guacamole/guacamole:0.9.11-incubating-RC1 .
$ sudo docker push guacamole/guacamole:0.9.11-incubating-RC1

Upload documentation and release notes

The draft release notes and updated documentation both need to be uploaded to the website prior to calling the PPMC vote. These changes should be handled like any other website changes - via pull requests against the incubator-guacamole-website repository. DO NOT UPDATE THE TOP-LEVEL DOCUMENTATION SYMBOLIC LINKS! The top-level symbolic links in the doc/ directory of incubator-guacamole-website point to the documentation for the latest release, and are thus only updated once the release is complete.

Take a look at past release notes to get an idea for the expected format. There is no hard-set requirement for the format of release notes, but things should be as consistent as possible. Use JIRA to query the issues which have been completed for the release, manually excluding issues which relate only to other issues already in the release (bug fixes for a release-specific change, for example).

Because the script that handles updating project websites often fails to update for large commits (see INFRA-10751), uploading documentation first, waiting a bit, and then uploading the release notes has a greater chance of working. Splitting the two uploads also helps facilitate code review, as the release notes will be buried in a sea of auto-generated HTML otherwise.

Examples:

Create the PPMC [VOTE] thread

Once the above has been completed, request a vote with an email to dev@guacamole.incubator.apache.org titled [VOTE] Release Apache Guacamole [VERSION] (RC[N]), containing the following:

Hello all,

The [NTH] release candidate for Apache Guacamole [VERSION] has been
uploaded and is ready for VOTE. The draft release notes (along with links
to artifacts, signatures/checksums, and updated documentation) can be found
here:

http://guacamole.incubator.apache.org/releases/[VERSION]/

The git tag for all relevant repositories is "[VERSION]-RC[N]":

https://github.com/apache/incubator-guacamole-client/tree/[VERSION]-RC[N]
https://github.com/apache/incubator-guacamole-server/tree/[VERSION]-RC[N]
https://github.com/apache/incubator-guacamole-manual/tree/[VERSION]-RC[N]

Build instructions are included in the manual, which is part of the updated
documentation referenced above. For convenience:

http://guacamole.incubator.apache.org/doc/[VERSION]/gug/installing-guacamole.html

Maven artifacts for guacamole-common, guacamole-common-js, and
guacamole-ext can be found in the following staging repository:

[STAGING REPOSITORY URL]

Source and binary distributions (also linked within the release notes):

https://dist.apache.org/repos/dist/dev/incubator/guacamole/[VERSION]-RC[N]/

Artifacts have been signed with the "[EMAIL]" key listed in:

https://dist.apache.org/repos/dist/dev/incubator/guacamole/KEYS

Please review and vote:

[ ] +1 Approve the release
[ ] -1 Don't approve the release (please provide specific comments)

This vote will be open for at least 72 hours.

Here is my +1.

Thanks,

[YOU]

Where [VERSION] is the release version, [N] and [NTH] are the number of the release candidate, [STAGING REPOSITORY URL] is the URL of the staging repository created earlier, [EMAIL] is the email address associated with the PGP key used to sign the release artifacts, and [YOU] is your name. Obviously, alter the email as necessary if the scope of the release is different.

Please note that, though community input is welcome, only PPMC votes count toward the required three “+1” votes.

Example: the 0.9.10-incubating-RC3 PPMC VOTE email

If any release-blocking issues are discovered, the vote must be canceled and development must resume, followed by another release candidate (prepared as above) intended to address those issues.

Create the IPMC [VOTE] thread

If/when the PPMC vote passes, another vote must be started for the IPMC. Only IPMC votes are binding here. Send an email to general@incubator.apache.org titled [VOTE] Release Apache Guacamole [VERSION] (RC[N]) containing the following:

Hello Incubator PMC,

The Apache Guacamole community has voted on and approved a proposal to
release Apache Guacamole [VERSION].

We now kindly request that the Incubator PMC members review and vote
on this incubator release.

The VOTE RESULT is here:

[LINK TO VOTE RESULT]

The draft release notes (along with links to artifacts,
signatures/checksums, and updated documentation) can be found here:

http://guacamole.incubator.apache.org/releases/[VERSION]/

The git tag for all relevant repositories is "[VERSION]-RC[N]":

https://github.com/apache/incubator-guacamole-client/tree/[VERSION]-RC[N]
https://github.com/apache/incubator-guacamole-server/tree/[VERSION]-RC[N]
https://github.com/apache/incubator-guacamole-manual/tree/[VERSION]-RC[N]

Build instructions are included in the manual, which is part of the
updated documentation referenced above. For convenience:

http://guacamole.incubator.apache.org/doc/[VERSION]/gug/installing-guacamole.html

Maven artifacts for guacamole-common, guacamole-common-js, and
guacamole-ext can be found in the following staging repository:

[STAGING REPOSITORY URL]

Source and binary distributions (also linked within the release notes):

https://dist.apache.org/repos/dist/dev/incubator/guacamole/[VERSION-RC[N]/

Artifacts have been signed with the "[EMAIL]" key listed in:

https://dist.apache.org/repos/dist/dev/incubator/guacamole/KEYS

Please review and vote:

[ ] +1 Approve the release
[ ] -1 Don't approve the release (please provide specific comments)

This vote will be open for at least 72 hours.

Thanks,

[YOU]

Where [LINK TO VOTE RESULT] the permalink to the specific email calling the result of the PPMC vote on the public archive of dev@guacamole.incubator.org, and all other fields are as described for the PPMC vote email.

Example: the 0.9.10-incubating-RC3 IPMC VOTE email