[10034] Update the release process documentation. #1465
Conversation
.readthedocs.yml
Outdated
| # This should not fail on errors. | ||
| # We have a separate build process which fails on errors and shows all | ||
| # the errors in one go. | ||
| fail_on_warning: false |
There was a problem hiding this comment.
I think it's worth enabling this once we can ignore the warnings in ToC sphinx-doc/sphinx#8289
(Sphinx 3.3.0)
There was a problem hiding this comment.
Right now, it is blocked by a different issue.
When fail on warnings is True, read the docs will not build the HTML files..so you can't check the partial output.
I was expecting that this PR will fix it readthedocs/readthedocs.org#7251
but when sphinx build fails, I still don't get HTML files
|
|
||
| - Download the latest ``.whl`` files from `Buildbot <https://buildbot.twistedmatrix.com/builds/twisted-packages/>`_ and save them in the staging directory | ||
|
|
||
| #. Sign the tarballs and Windows installers. |
There was a problem hiding this comment.
I think it's worth publishing that the releases are no longer signed
There was a problem hiding this comment.
Yes. I think that this should be top level info for the next release together with the fact that 2.7 is no longer supported.
| ## Remove this section | ||
|
|
||
| Please have a look at [our developer documentation](https://twistedmatrix.com/trac/wiki/TwistedDevelopment#SubmittingaPatch) before submitting your Pull Request. | ||
|
|
||
| Please note that the trac ticket, news fragment, and review submission portions of this process apply to *all* pull requests, no matter how small; if you don't do them, it's likely that nobody will even notice your PR needs a review. | ||
|
|
||
|
|
There was a problem hiding this comment.
This was intentional. The reasoning is.
2 empty lines before a section title. 1 empty line after a section title
In this way, I find it easier to detect sections :)
|
As there are no major complains, I am going to merge this as soon as all the tests are green. |
|
@adiroiban It was not good practice for you to submit this change to the release process documentation, and merge it after @graingert approved very quickly. You are not the current release engineer for Twisted, and @graingert does not have a track record as a release engineer for the Twisted project. You submitted this change right in the middle of a time when a lot of people are on holiday. |
|
Feel free to revert it. I have requested the review on 23 of Oct and merged, it was approved by graingert on 3rd of Nov and I merged on the 24 of Dec. Good luck |
Scope
This is the proposed release process once we autimated the downloads and docs with GitHub Actions + PyPI + Read the docs.
Here you can see the result https://twisted--1465.org.readthedocs.build/en/1465/core/development/policy/release-process.html
Contributor Checklist:
tox -e lintto format my patch to meet the Twisted Coding Standardreviewto the keywords field in Trac, and putting a link to this PR in the comment; it shows up in https://twisted.reviews/ now.