Release Procedure

This page summarizes the steps that need to be taken when performing a GRNsight release. Steps are manual for now, but documenting them is the first step toward facilitating automation in the future.

The list is coded up using checkboxes, so that its source can be copied into a GitHub issue as a starting point for preparing a new release.

• Merge the branch(es) under development into master
  • Resolve any version control conflicts
  • Test the final merged version
  • Perform hotfixes on master as needed
• Tag the final, tested version as v#.#.# (all three numbers are required, even if 0; see npm step below)
  • Remember that the tag needs to be pushed to GitHub: git push origin <tag-name>
• Create draft release item on Github repository (name it exactly like the tag)
  • Make release notes: a list of new features/bug fixes with issue numbers covered by this release
• Publish GitHub release item
• Publish release to GRNsight home page
  • Update the version number and modification date on gh-pages
• Increment beta version
  • Merge released master with beta, especially if hotfixes/merges were made on master
  • Update version number and modified date on gh-pages
• Publish to npm
  • Update version numbers in all package.json files
  • npm requires all .0s in the semantic version
  • Check to see that BioJS updates its GRNsight entry
• Run Istanbul and note new test coverages (optional)
• Update the About page with release notes (GitHub release item without issue numbers)
  • Update modification date
• Add news item about the release to the News page
  • Update modification date
  • Link news item to the corresponding release notes in the About page
• Update Documentation page with any new features or updates to old features
• Update version number/other relevant information at current bioinformatics listing sites
  • Elixir
    • Then change hyperlink on the GRNsight Links page, if necessary
• Get DOI for new release from Zenodo
  • get badge and include in README.md at top level of repo
  • update CITATION.md file with DOI (and badge?) for the new release
  • update "How to cite GRNsight" section on About page