Skip to content

Instantly share code, notes, and snippets.

@rdeltour

rdeltour/README.md

Last active August 17, 2017 14:50
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save rdeltour/4c4ef6c1b50a277f1135b75d23d698c2 to your computer and use it in GitHub Desktop.
Save rdeltour/4c4ef6c1b50a277f1135b75d23d698c2 to your computer and use it in GitHub Desktop.
Download ZIP
How to release the Pipeline 2 project
Raw
README.md

Pipeline 2 Release guide

Releasing the main distribution (pipeline-assembly)

  1. Finalize the release notes
  2. Tag the assembly
  3. Merge all the release branches
  4. Close all the v1.10.2 milestones
  5. Build the distribution packages
  6. Upload the distribution to GitHhub and publish the release
  7. Send the announcement to the lists

Editing the release notes

Searching the issue can help compiling the release notes:

The release notes must be updated in the distribution README file in the assembly project:

  • Update the version number and date in the README title (TODO should be automated, see issue #512)
  • Edit the Release Notes section
  • Make sure the link to the release page is updated too

The release notes should also be copied to a new GitHub release draft on the pipeline-assembly project.

Sending the announcement

An email announcement should be sent to the following lists:

The announcement can be based on the following template:

Subject: Pipeline 2 vXYZ released

Dear all,

Version XYZ of the DAISY Pipeline 2 project is now available for download. The following alternative packages are proposed:

All distributions include the new graphical user interface (GUI), all the conversion scripts, and a native command line tool (CLI).

This release features notably:

  • XXX insert highlights of the release

If you have any problems or identify some bugs, please report them to the Pipeline team using our issue tracker on GitHub:
https://github.com/daisy/pipeline/issues

For details, please refer to the full release notes:
https://github.com/daisy-consortium/pipeline-assembly/releases/tag/vXYZ

User documentation is now available on the project’s web site:
http://daisy.github.io/pipeline/

As usual, feedback is warmly welcome!

Releasing a module

  1. Pull master repo
  2. Create release branch
  3. Set fixed versions
  4. Check semver git log vX.Y.Z..
  5. Comment-out from the BoM any module that do not need to be built
  6. Release with the Maven Release Plugin
  • mvn release:clean release:prepare -DpushChanges=false
  • mvn release:perform -DlocalCheckout=true
  1. close staging repo in Sonatype
  2. reset the versions in BOM
  3. push branch and create PR
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment