Skip to content

Releasing.md

Latest commit

 

History

History
199 lines (136 loc) · 8.53 KB

Releasing.md

File metadata and controls

199 lines (136 loc) · 8.53 KB

Generating the licenses for the NPM dependencies

Before a release can be performed the npm license need to be updated with any new dependencies. This file is found under artemis-console-distribution/src/main/resources/licenses/licenses/NPMLicenses.txt.

To regenerate the licenses cd into artemis-console-extension/artemis-extension and run

yarn license

Note that a check can be made to identify any possible problematic licenses by running in the artemis-console-extension/artemis-extension directory:

npx license-checker --out licenses.csv --csv --onlyAllow "Apache-2.0;ISC;MIT;CC0-1.0;BSD-2-Clause;BSD-3-Clause;Python-2.0;UNLICENSED;MPL-2.0;CC-BY-4.0;Unlicense;0BSD;BlueOak-1.0.0"

dependencies marked as unlicensed will need to be manually checked.

Checking out a new empty git repository

Before starting make sure you clone a brand new git as follows as the release plugin will use the upstream for pushing the tags:

git clone https://gitbox.apache.org/repos/asf/artemis-console.git
cd artemis-console

If your git user.email and/or user.name are not set globally then you'll need to set these on the newly clone repository as they will be used during the release process to make commits to the upstream repository, e.g.:

git config user.email "username@apache.org"
git config user.name "FirstName LastName"

This should be the same user.email and user.name you use on your main repository.

Running the release

You will have to use this following maven command to perform the release:

mvn clean release:prepare -Prelease

You could optionally set pushChanges=false so the version commit and tag won't be pushed upstream (you would have to do it yourself):

mvn clean release:prepare -DpushChanges=false -Prelease

When prompted make sure the new development version matches with the next expected release, rather than the offered patch release. Example:

[INFO] Checking dependencies and plugins for snapshots ...
What is the release version for "Apache Artemis Console Project"? (artemis-console-project) 1.5.0: :
What is the SCM release tag or label for "Apache Artemis Console Project"? (artemis-console-project) 1.5.0: :
What is the new development version for "Apache Artemis Console Project"? (artemis-console-project)1.5.1-SNAPSHOT: : 1.6.0-SNAPSHOT

For more information look at the prepare plugin:

If you set pushChanges=false then you will have to push the changes manually. The first command is to push the commits which are for changing the <version> in the pom.xml files, and the second push is for the tag, e.g.:

git push upstream
git push upstream <version>

Uploading to nexus

Ensure that your environment is ready to deploy to the ASF Nexus repository as described at Publishing Maven Artifacts

Copy the file release.properties, that is generated at the root of the project during the release, before starting the upload. You could need it if the upload fails.

To upload it to nexus, perform this command:

mvn release:perform -Prelease

Note: this can take quite a while depending on the speed for your Internet connection.

Finally, upload the relocations to ASF Nexus:

cd target/checkout/relocations/
mvn deploy -Papache-release,deploy-relocations

If the upload fails or is interrupted, remove the incomplete repository using the "Drop" button on Nexus website. Before starting the upload again, check the release.properties at the root of the project.

Keep the checkout used to run the release process for later reference.

Resuming release upload

If something happened during the release upload to nexus, you may need to eventually redo the upload. Remove the incomplete repository using the "Drop" button on Nexus website. Before starting the upload again, check the release.properties at the root of the project.

There is a release.properties file that is generated at the root of the project during the release. In case you want to upload a previously tagged release, add this file as follows:

  • release.properties
scm.url=scm:git:https://github.com/apache/artemis-console.git
scm.tag=1.0.0

Closing the staging repositories

A staging repository will be created for the main release, and another created for the relcations deployed separately. Give the staging repositories contents a quick inspection using the content navigation area, then proceed to close the staging repos using the "Close" button on Nexus website, locking them from further modification and exposing their contents at staging URLs to allow testing. Set a description such as "Artemis Console (RC1)" while closing.

Stage the release to the dist dev area

Use the closed staging repo contents to populate the dist dev svn area with the official release artifacts for voting. Use the script already present in the repo to download the files and populate a new ${CURRENT-RELEASE} dir:

svn co https://dist.apache.org/repos/dist/dev/artemis/artemis-console/
cd artemis-console
./prepare-release.sh https://repository.apache.org/content/repositories/orgapacheartemis-${NEXUS-REPO-ID} ${CURRENT-RELEASE}

Give the files a check over and commit the new dir and start a vote if all looks well.

svn add <version>
svn commit

Old staged releases can be cleaned out periodically.

Send Email

Once all the artifacts are stage then send an email to dev@artemis.apache.org. It should have a subject like [VOTE] Apache Artemis Console <version>.

Voting process

Rules for the Apache voting process are stipulated here.

Assuming the vote is successful send a email with a subject like [RESULT] [VOTE] Apache Artemis Console <version> informing the list about the voting result.

Web site update:

Wait for the CDN to sync first after updating SVN, and additionally for Maven Central to sync, before proceeding.

The CDN content can be viewed here. The Maven Central content can be viewed here.

Clone the artemis-website repository:

git clone https://gitbox.apache.org/repos/asf/artemis-website.git
cd artemis-website

NOTE: Some of the release scripts use Python, ensure you have it installed before proceeding. Also, the PyYAML lib is used. Examples for installing that include using dnf install python3-pyyaml on Fedora, or installing it using Pip by running pip install pyyaml.

Once the CDN and Maven Central are up-to-date then update the site as follows:

  1. Run the release addition script to generate/perform most of the updates by running command of form:
./scripts/release/add-artemis-console-release.sh <path.to>/artemis-console <previous-version> <new-version>

This does the following:

  • Creates the new release collection file at src/_artemis_console_releases/artemis-console-<padded-version-string>.md.
  • Creates the new release notes file at src/components/artemis-console/download/release-notes-<new-version>.md.
  • Creates src/components/artemis-console/documentation/version/<previous-version> and copies the previous version's documentation from src/components/artemis-console/documentation/latest into it.
  • Copies new documentation from the build directory into src/components/artemis-console/documentation/latest.
  • Updates .htaccess file in src/components/artemis-console/documentation to properly load the "latest" docs when accessing src/components/artemis-console/documentation/version/<new-version>.

Example from the 1.6.0 release:

./scripts/release/add-artemis-console-release.sh ../artemis-console 1.5.0 1.6.0
  1. Open the release collection file at src/_artemis_console_releases/artemis-console-<padded-version-string>.md and update shortDescription as appropriate to the release content.
  2. Update the artemis_console list within the src/_data/current_releases.yml file if needed to set the new version stream as current.

Check over git status etc. Run git add for all the added directories & files and then git commit -m "updates for artemis-console <version> release". Once pushed, the changes should be published automatically by the jekyll_websites builder of the apache buildbot.