Skip to content

SPAdes release how to

Jump to bottom
Anton Korobeynikov edited this page Jun 3, 2024 · 11 revisions

Pre-release checks

  • Check whether all new options and changes are well documented in docs/running.md, including links, dates and version.
  • Check if documentation should be updated
  • Set proper version in VERSION
  • List all new features and changes in changelog.md
  • Update LICENSE if needed

Creating SPAdes distributive

Source code archive

  • Make sure you repository is clear (git clean -f)
  • Run ./make-targz.sh

Binaries

  • Create tag, push it
  • The release snapshot pipeline should run
  • Wait until (draft) release is created

Checking SPAdes distributive

  • Compile SPAdes with ./spades_compile.sh (only for source code)
  • Run all kinds of tests to check everything is compiled and packed correctly:
./spades.py --test --sc
./spades.py --test --careful
./spades.py --test --iontorrent
./truspades.py --test
./rnaspades.py --test
./plasmidspades.py --test
./metaspades.py --test
./rnaspades.py --test --ss-rf
./rnaspades.py --test --iontorrent
./coronaspades.py  --test
./metaplasmidspades.py  --test
./metaviralspades.py  --test
./plasmidspades.py  --test
./rnaviralspades.py  --test

Publishing the release

Upload all 3 archives (source code, Linux and MacOS binaries) to the lab's web-site

Push the release branch to a public repository

  • Add git remote: git remote add spades git@github.com:ablab/spades.git
  • Check for git remote:
git remote -v
origin	git@github.com:ablab/algorithmic-biology.git (fetch)
origin	git@github.com:ablab/algorithmic-biology.git (push)
spades	 git@github.com:ablab/spades.git (fetch)
spades	 git@github.com:ablab/spades.git (push)
  • Switch to the release branch git checkout spades_N.M.K
  • Push the branch git push spades spades_N.M.K (here spades is the remote name for spades.git)
  • Create new tag vN.M.K in spades.git
  • Create GitHub release using web interface, use changelog.html to list changes

Publicity

User mailing list

  • Download all user data from lab's web-site (ninja form #2)
  • Extract all emails for users who wrote us on support email since the last release using a special (available in the respective Google spreadsheet under SPAdes support account)
  • Add new users to mailgun
  • Create an email in html format similar to assembler/src/tools/mail_sender/message.html
  • Run a mail-sending script using a private mailing API key
Clone this wiki locally