rele icon indicating copy to clipboard operation
rele copied to clipboard

Streamlining the Release process

Open andrewgy8 opened this issue 5 years ago • 3 comments

Boy oh boy, that release process was a doozy. Anybody have experience with making the release process easier to compose?

To create 0.4.0, I had to,

  • Bump the __version__
  • Create the changelog
  • Create the release on github which was basically a copy/pasta of the changelog
  • make release on my machine.

Needless to say, there was a lot of room for error and improvement.

What would be nice to have is a:

This for sphinx documentation https://releases.readthedocs.io/en/latest/ This for versioning https://github.com/c4urself/bump2version This for changelog generation https://github.com/vaab/gitchangelog

Any other sources? Experiences?

andrewgy8 avatar Jun 17 '19 08:06 andrewgy8

I see the guys maintaining marshmallow have a releasing guide that seems pretty simple to follow. Maybe we can learn a few things from them 😄

daniel-ruiz avatar Jun 17 '19 14:06 daniel-ruiz

Good source @daniel-ruiz ! They also have fairly simple travis build which does use tox. https://github.com/marshmallow-code/marshmallow/blob/dev/.travis.yml

andrewgy8 avatar Jun 17 '19 15:06 andrewgy8

Just because they have removed it from their repo, here is the travis file https://github.com/marshmallow-code/marshmallow/commit/ead95c2624b66ec9ab2fa9c83b55e60929599c2a

Curious that they migrated from travis to azure pipelines. Seems to be the number of parallel jobs for OS projects. The azure pipelines yaml also looks very simple.

andrewgy8 avatar Jul 23 '19 06:07 andrewgy8