Deepreg: Add auto pypi release and update releasing guidelines

Created on 3 Sep 2020  路  9Comments  路  Source: DeepRegNet/DeepReg

Subject of the issue

We need to clarify release guidelines. When to release? Conventions? Write in a guide for posterity? Discuss.

docs priority

Most helpful comment

All 9 comments

@mathpluscode @ebonmati @MattClarkson @YipengHu @RemiDelaunay @YipengHu @QianyeYang @acasamitjana @agrimwood @zacbaum @ZheMin-1992 @s-sd

When: Perhaps once per month (or longer)

Naming conventions: Per semver (Major.Minor.Batch - Major is non-backward compatible changes, minor is large changes that add new functionality, batch is fixes or small updates)

I would be in favor of manually triggered GitHub action which:

  • Creates a tag
  • Builds release package
  • Pulls changelog (from somewhere, see #407)
  • Adds release to GitHub & PyPI

Alternatively - create a tag which then:

  • Triggers CI for that tagged commit
  • Builds release package
  • Pulls changelog (from somewhere, see #407)
  • Adds release to GitHub & PyPI

minor: I think is Major.Minor.Patch instead of Major.Minor.Batch

Also, once per month at which level? batch?

minor: I think is Major.Minor.Patch instead of Major.Minor.Batch

Good catch!

Also, once per month at which level? batch?

I think this would depend on the amount of work done since the last release.

When: Perhaps once per month (or longer)

Naming conventions: Per semver (Major.Minor.Batch - Major is non-backward compatible changes, minor is large changes that add new functionality, batch is fixes or small updates)

I would be in favor of manually triggered GitHub action which:

  • Creates a tag
  • Builds release package
  • Pulls changelog (from somewhere, see #407)
  • Adds release to GitHub & PyPI

Alternatively - create a tag which then:

  • Triggers CI for that tagged commit
  • Builds release package
  • Pulls changelog (from somewhere, see #407)
  • Adds release to GitHub & PyPI

Vote for github action!

When: Perhaps once per month (or longer)
Naming conventions: Per semver (Major.Minor.Batch - Major is non-backward compatible changes, minor is large changes that add new functionality, batch is fixes or small updates)
I would be in favor of manually triggered GitHub action which:

  • Creates a tag
  • Builds release package
  • Pulls changelog (from somewhere, see #407)
  • Adds release to GitHub & PyPI

Alternatively - create a tag which then:

  • Triggers CI for that tagged commit
  • Builds release package
  • Pulls changelog (from somewhere, see #407)
  • Adds release to GitHub & PyPI

Vote for github action!

  • 1 GitHub action

343 Closed as a duplicate of this - see there for more discussion/ideas for going about this (in an automated fashion) as well.

btw lol DeepRegbeta will be released in Autumn 2020 we gonna enter winter...

Was this page helpful?
0 / 5 - 0 ratings