Skip to content

Releasing BoneJ

Alessandro Felder edited this page Apr 17, 2019 · 28 revisions

This is a check list of things to do before releasing a new version(s) of the BoneJ Maven artefacts.

  1. Code that has become obsolete has been @Deprecated
  2. @Deprecated code carried over from previous versions has been removed
  3. TODOs minimized.
  4. Update all dependencies with explicit version numbers if needed
    • Make necessary changes, or mark for resolving later (e.g. newly deprecated code)
  5. Check that code compiles and test pass (mvn clean package)
    • Run slow tests for wrapperPlugins too (mvn test -P allTests). They may fail due to time outs. Check that they don't fail repeatedly.
  6. Check that dependencies are correctly marked (mvn dependency:analyze shows no warnings)
  7. Check Javadoc is OK (mvn javadoc:javadoc)
  8. Carefully initiate the "double push"
    • Update artefact versions to stable according to semantic versioning
    • Comment out modules that don't get released
    • Also update the parent artefacts
    • Double check that parents list correct module numbers, and affected modules the correct parents
    • git push to master
  9. Check that Travis build passes
  10. Complete the "double push"
    • Update affected artefacts to next SNAPSHOT versions
    • Activate modules previously commented out
    • Also update pom parents to next SNAPSHOT
    • Double check artefact numbers
  11. Update documentation

Additionally if you want to make this a new user release

  1. Tag the commit where artefact(s) were released
  2. Draft a release, following the style in prior releases
  3. Check that Zenodo has archived the release code
  4. Ensure that the user docs are up to date
  5. Update the imagej.net Wiki with a redirect for new plugins
  6. Upload new artefact(s) to the update site.
  7. Announce the release on the forum and Twitter
Clone this wiki locally