nf-core / nf-core/tools

Automate Releases

Open
#319 10 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

automation low-priority
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Since we already insist on having people work on dev branches & master branches only incorporating stable code, we could also produce a way of making automated releases too:

https://github.com/semantic-release/semantic-release

This would only require:

  • Setting the master branch protected for everyone, except for PRs coming from dev
  • Forcing everyone to NEVER merge to master except for releases that have been tested on dev (which we anyways do)

Could then configure the method above to make a release whenever coming from master and something has been changed. If people then also use the CHANGELOG.md, it would automatically do proper and nice releases :-)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the semantic-release proposal and the repository's dev and master branch workflow, including CHANGELOG.md. Done means releases are triggered for changed, tested code reaching master, with the stated branch protection and merge rules in place.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
ci-cd, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.