Opened 7 years ago

Closed 13 months ago

#4543 task closed fixed (fixed)

Move release process document to version control

Reported by: Jonathan Lange Owned by: hawkowl
Priority: normal Milestone: totally automated release infrastructure
Component: release management Keywords:
Cc: Thijs Triemstra, Trevor Bramwell Branch: branches/release-process-4543
branch-diff, diff-cov, branch-cov, buildbot
Author: hawkowl

Description

ReleaseProcess should be moved into version control and managed there.

The document on the wiki is now basically complete and probably mostly accurate. Where it's wrong, that's a defect, and where the process can be changed to be better, that's an enhancement.

The length and complexity of the process it describes makes it a near essential to doing the release. It ought to live near all of the other release essentials.

It refers to numerous scripts based in the tree. When these scripts change, the document ought to change as well.

Attachments (1)

version-control-release-process-4543-1.patch (20.4 KB) - added by Trevor Bramwell 3 years ago.
ReST Version of Release Process

Download all attachments as: .zip

Change History (15)

comment:1 Changed 7 years ago by Glyph

If the sphinx conversion is imminent, it might be worthwhile to wait for it. However, sphinx or lore, how do you propose to convert the document into something suitable for viewing and editing in SVN as opposed to trac markup? (Are you volunteering to do the translation manually?)

comment:2 Changed 7 years ago by Jonathan Lange

Yes, volunteering to do the transition manually.

Where can I track progress on Sphinx stuff?

Note that switching to Sphinx rather than Lore requires changes to the release process itself, which is one of the reasons I'm keen to have this in the tree.

comment:3 in reply to:  2 Changed 7 years ago by Glyph

Replying to jml:

Yes, volunteering to do the transition manually.

Where can I track progress on Sphinx stuff?

The best answer I can find is this: http://twistedsphinx.funsize.net/transition_plan.html

Somebody should really bug khorn to turn that into a ticket.

Note that switching to Sphinx rather than Lore requires changes to the release process itself, which is one of the reasons I'm keen to have this in the tree.

Yes, definitely.

comment:4 Changed 7 years ago by Jonathan Lange

I've filed #4553 to be that master ticket.

comment:5 Changed 6 years ago by <automation>

Owner: radix deleted

comment:6 in reply to:  4 Changed 6 years ago by Thijs Triemstra

Cc: Thijs Triemstra added

Replying to jml:

I've filed #4553 to be that master ticket.

See #4500 for the master ticket.

comment:7 Changed 3 years ago by Trevor Bramwell

Owner: set to Trevor Bramwell
Status: newassigned

Changed 3 years ago by Trevor Bramwell

ReST Version of Release Process

comment:8 Changed 3 years ago by Trevor Bramwell

Cc: Trevor Bramwell added
Keywords: review added
Owner: Trevor Bramwell deleted
Status: assignednew

I have manually converted (with a little help from html2rst) the Release Process wiki page into reStructuredText format.

None of the content should have changed, though it is probably in the process I might have munged some text while updating the formatting.

The initial text regarding changes to the doc I placed in a 'warning' declaration, and any obvious notes I replaced with note declarations.

comment:9 Changed 3 years ago by Jean-Paul Calderone

Keywords: review removed
Resolution: wontfix
Status: newclosed

Considering the release process is still changing, mostly in response to surprises encountered by release managers, and that there are currently known problems with the process, I think that it would be premature to make this change.

In fact, I wonder why we want to do it at all. The ticket description says "It ought to live near all of the other release essentials." but this doesn't sound like much of a reason. It's not hard to find the ReleaseProcess wiki page. It *is* kind of hard to find most of the rest of our documentation though...

comment:10 Changed 13 months ago by hawkowl

Resolution: wontfix
Status: closedreopened

I'm reopening this. As our release process implementations change in our source tree (especially with the git migration), it would be nice to have the documented process change with it. For example, #7985 -- it's hard to say what the *new* process would be with any release process changes in a coherent way. If bugs are encountered in the release process, the release ticket can also include the tested alterations to the process.

comment:11 Changed 13 months ago by hawkowl

Author: hawkowl
Branch: branches/release-process-4543

(In [46919]) Branching to release-process-4543.

comment:12 Changed 13 months ago by hawkowl

Keywords: review added; documentation removed

Unfortunately I changed a lot since bramwelt's patch, so I re-rst'd it from scratch.

Builders spun. Please review.

comment:13 Changed 13 months ago by Adi Roiban

Keywords: review removed
Owner: set to hawkowl
Status: reopenednew

Thanks. Looks good.

I am happy to have this outside of the wiki and change it together with the release process.


Minor comments.

  1. For the 'What bugs should be considered release blockers?' I would add in that list: Any bug which makes the current release worse than the previous one.
  1. Also, there is a formatting error for that list as all answers are not presented as a list.
  1. Same list formatting error for Prepare the branch: 4. Make a new quote file for the next version

Looks good.

Please check my comments and merge.

One this is merge and we have a new release, please don't forget to remove the current wiki page and add a link to the new documentation.

Thanks!

comment:14 Changed 13 months ago by hawkowl

Resolution: fixed
Status: newclosed

(In [46931]) Merge release-process-4543: Move the release process docs into the source tree

Author: hawkowl Reviewer: adiroiban Fixes: #4543

Note: See TracTickets for help on using tickets.