New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create and follow a "release checklist" #1477

Closed
fingolfin opened this Issue Jul 5, 2017 · 6 comments

Comments

Projects
None yet
2 participants
@fingolfin
Member

fingolfin commented Jul 5, 2017

It would be good if we had a "release checklist", like other biggish projects:

Such a checklist would contain all steps required to make a release. Really, all of them, from how and which mailing lists to notify when, what and how to tag, how to make tarballs, how and where to upload them, a list of sites or mailing lists to notify about the release etc. (for an example, see e.g. http://wiki.scummvm.org/index.php/HOWTO-Release which I created a decade ago).

This serves several purposes:

  1. To make sure knowledge is not lost, and thus to reduce the bus factor -- right now, I think only @alex-konovalov knows all of this, and if he is incapacitated, we have a problem. The other p
  2. To make sure no steps are forgotten during a release (think of an airplan pilot's take-off checklist)
  3. It allows auditing the whole process, and also allows identifying opportunities for improvements, such as extra steps which can be automated.

The closest to this I am aware of is https://github.com/gap-system/gap/wiki/GAP-release-workflow but this page is woefully incomplete, and I am pretty sure @alex-konovalov does not actually use it ;-).

UPDATE: @alex-konovalov has now a nice such checklist on https://github.com/gap-system/gap-distribution/blob/master/DistributionUpdate/RELEASE_CHECKLIST.md

@alex-konovalov

This comment has been minimized.

Show comment
Hide comment
@alex-konovalov

alex-konovalov Jul 14, 2017

Member

Needed action, and it was already in my plan. You're right that I am not actually using it. I use doc/dev manual and some other notes instead. I should take care of this issue - ideally while making the next release.

Member

alex-konovalov commented Jul 14, 2017

Needed action, and it was already in my plan. You're right that I am not actually using it. I use doc/dev manual and some other notes instead. I should take care of this issue - ideally while making the next release.

@alex-konovalov

This comment has been minimized.

Show comment
Hide comment
@alex-konovalov

alex-konovalov Jul 26, 2017

Member

Not a full release checklist, but documentation for release wrapping scripts updated in Feb 2017 is at https://github.com/gap-system/gap-distribution/blob/master/DistributionUpdate/README.md

Member

alex-konovalov commented Jul 26, 2017

Not a full release checklist, but documentation for release wrapping scripts updated in Feb 2017 is at https://github.com/gap-system/gap-distribution/blob/master/DistributionUpdate/README.md

@alex-konovalov

This comment has been minimized.

Show comment
Hide comment
@alex-konovalov

alex-konovalov Aug 21, 2017

Member

I've started notes at https://github.com/gap-system/gap-distribution/wiki/Release-checklist, plan to expand them while publishing GAP 4.8.8 shortly.

Member

alex-konovalov commented Aug 21, 2017

I've started notes at https://github.com/gap-system/gap-distribution/wiki/Release-checklist, plan to expand them while publishing GAP 4.8.8 shortly.

@alex-konovalov

This comment has been minimized.

Show comment
Hide comment
@alex-konovalov

alex-konovalov Sep 4, 2017

Member

https://github.com/gap-system/gap-distribution/wiki/Release-checklist has been expanded a lot while I've been publishing GAP 4.8.8. Maybe it now could be placed under version control in gap-distribution repository so that one could easier submit PRs to edit it.

Member

alex-konovalov commented Sep 4, 2017

https://github.com/gap-system/gap-distribution/wiki/Release-checklist has been expanded a lot while I've been publishing GAP 4.8.8. Maybe it now could be placed under version control in gap-distribution repository so that one could easier submit PRs to edit it.

@alex-konovalov

This comment has been minimized.

Show comment
Hide comment
@alex-konovalov

alex-konovalov Sep 15, 2017

Member

The release checklist has been placed under version control here: https://github.com/gap-system/gap-distribution/blob/master/DistributionUpdate/RELEASE_CHECKLIST.md.

You can now comment on it on the commit gap-system/gap-distribution@86283c6 and submit pull requests with suggested modifications.

Will keep this issue open for a while to make more developers aware of the checklist and solicit comments.

Member

alex-konovalov commented Sep 15, 2017

The release checklist has been placed under version control here: https://github.com/gap-system/gap-distribution/blob/master/DistributionUpdate/RELEASE_CHECKLIST.md.

You can now comment on it on the commit gap-system/gap-distribution@86283c6 and submit pull requests with suggested modifications.

Will keep this issue open for a while to make more developers aware of the checklist and solicit comments.

@alex-konovalov alex-konovalov referenced this issue Jun 8, 2018

Open

Meta: Improve our release process #636

0 of 12 tasks complete
@alex-konovalov

This comment has been minimized.

Show comment
Hide comment
@alex-konovalov

alex-konovalov Jun 8, 2018

Member

I've followed this checklist in subsequent releases to validate it. Added some omissions and corrected some statements. It seems now in an adequate shape.

Member

alex-konovalov commented Jun 8, 2018

I've followed this checklist in subsequent releases to validate it. Added some omissions and corrected some statements. It seems now in an adequate shape.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment