Skip to content
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

[Fix #10216] Update the release documentation with feedback from the 21.7.0 release. #1616

Merged
merged 26 commits into from
Jan 27, 2022

Conversation

adiroiban
Copy link
Member

@adiroiban adiroiban commented Jul 8, 2021

Scope and purpose

This is a minor release doc update while doing an actual release.

Updated docs at https://twisted--1616.org.readthedocs.build/en/1616/core/development/policy/release-process.html

Contributor Checklist:

  • The associated ticket in Trac is here: https://twistedmatrix.com/trac/ticket/10216
  • [NA] I ran tox -e lint to format my patch to meet the Twisted Coding Standard
  • I have created a newsfragment in src/twisted/newsfragments/ (see: News files)
  • The title of the PR starts with the associated Trac ticket number (without the # character).
  • [NA] I have updated the automated tests and checked that all checks for the PR are green.
  • I have submitted the associated Trac ticket for review by adding the word review to the keywords field in Trac, and putting a link to this PR in the comment; it shows up in https://twisted.reviews/ now.
  • The merge commit will use the below format
    The first line is automatically generated by GitHub based on PR ID and branch name.
    The other lines generated by GitHub should be replaced.
Merge pull request #123 from twisted/4356-branch-name-with-trac-id

Author: adiroiban
Reviewer: 
Fixes: ticket:10216

Update the release documentation.

@adiroiban adiroiban changed the title [10216[ Update the release documentation with feedback from the 21.7.0 release. [10216] Update the release documentation with feedback from the 21.7.0 release. Jul 8, 2021
@adiroiban
Copy link
Member Author

adiroiban commented Jul 8, 2021

The main changes is making it clear that a review for a release candidate should be asked only after the RC is published on PyPI,

But maybe we should ask a review before pushing a PR.

Also, before starting the release branch, a message can be sent to IRC or mailing list to see if there is any PR for which the release can be delayed with 1 or 2 days... but not longer.
But maybe we don't need to document this and any release manager can do it or not.

Or just a info that as an optional step, the release manager can communicate the intention of a release .


Quick link for the review https://twisted--1616.org.readthedocs.build/en/1616/core/development/policy/release-process.html

@adiroiban adiroiban requested a review from a team July 8, 2021 17:10
Copy link
Member

@graingert graingert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

broken URL scheme

@adiroiban
Copy link
Member Author

Thanks @graingert for the review. Much appreciated.

I am still updating these notes while working on the release.

I will send one final review request after the final Twisted 21.7.0 is out.

@adiroiban
Copy link
Member Author

This is ready for a final review.
I left my comments based on the latest release experience.

For now, read the docs updates are manual ... I hope it can be fixed in #1629
but the documentation should for now mention that after the release you need to manually create the documentation for the tag.

@adiroiban adiroiban requested review from graingert and a team July 28, 2021 14:01
@graingert graingert self-requested a review January 26, 2022 23:01
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
@adiroiban adiroiban changed the title [10216] Update the release documentation with feedback from the 21.7.0 release. [Fix #10216] Update the release documentation with feedback from the 21.7.0 release. Jan 27, 2022
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
@adiroiban adiroiban merged commit 2d6a7d6 into trunk Jan 27, 2022
@adiroiban adiroiban deleted the 10216-release-docs-update-2021-07 branch January 27, 2022 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants