document release checklist by esc · Pull Request #6986 · numba/numba

esc · 2021-04-30T14:33:01Z

This adds documentation and templates for the Numba release process.

stuartarchibald · 2021-04-30T14:34:31Z

+.. code-block::
+
+    ## Numba X.Y.Z
+
+    * [ ] merge to master:
+        - [ ] "remaining Pull-Requests from milestone"
+    * [ ] merge change log changes
+        - [ ] "PR with changelog entries
+    * [ ] Create X.Y release branch
+    * [ ] pin llvmlite to `>=0.A.0rc1,<0.A+1.0`
+    * [ ] annotated tag X.Y.Zrc0 on release branch
+    * [ ] build and upload conda packages on buildfarm (check "upload")
+    * [ ] build wheels (`$PYTHON_VERSIONS`) on the buildfarm
+    * [ ] upload wheels and sdist to PyPI (upload from `ci_artifacts`)
+    * [ ] verify packages uploaded to Anaconda Cloud and move to `numba/label/main`
+    * [ ] verify wheels for all platforms arrived on PyPi
+    * [ ] verify ReadTheDocs build
+    * [ ] clean up `ci_artifacts`
+    * [ ] review, merge and check execution of release notebook
+    * [ ] send RC announcement email / post announcement to discourse group
+    * [ ] post link to Twitter
+    * [ ] post link to python-announce-list@python.org
+
+    ### Post Release:
+
+    * [ ] tag X.Y+1.0dev0 to start new development cycle on `master`
+    * [ ] update llvmlite dependency spec to match next version via PR to `master`
+    * [ ] update release checklist template
+    * [ ] close milestone (and then close this release issue)
+
+Second Releases Candidates, Final Releases and Patch Releases
+-------------------------------------------------------------
+
+A patch release usually involves a series of cherry-picks, so the recipe is
+slightly different.
+
+.. code-block::
+
+    ## numba X.Y.Z
+
+    * [ ] cherry-pick items from the X.Y.Z milestone into a PR
+    * [ ] merge change log modifications and cherry-picks to X.Y release branch
+    * [ ] https://github.com/numba/numba/pull/XXXX
+    * [ ] annotated tag X.Y.Z on release branch (no `v` prefix)
+    * [ ] build and upload conda packages on buildfarm (check "upload")
+    * [ ] build wheels (`$PYTHON_VERSIONS`) on the buildfarm
+    * [ ] upload wheels and sdist to PyPI (upload from `ci_artifacts`)
+    * [ ] verify packages uploaded to Anaconda Cloud and move to `numba/label/main`
+    * [ ] verify wheels for all platforms arrived on PyPi
+    * [ ] verify ReadTheDocs build
+    * [ ] clean up `ci_artifacts`
+    * [ ] send RC/FINAL announcement email / post announcement to discourse group
+    * [ ] post link to Twitter
+    * [ ] post link to python-announce-list@python.org
+
+    ### Post release
+
+    * [ ] cherry-pick change-log modifications to main branch (`master`)
+    * [ ] update release checklist template
+    * [ ] ping Anaconda Distro team to trigger a build for `defaults` (FINAL ONLY)
+    * [ ] close milestone (and then close this release issue)


Could these just be actual templates?

In this directory: https://github.com/numba/numba/tree/master/.github/ISSUE_TEMPLATE

Maybe. However, I am not sure we can git version control the templates then. I think keeping track of how they evolve might be useful. Maybe we can update the templates from the documentation directly?

@stuartarchibald that link is useful, I think that would be good then. Do we want to keep a test in the developer docs to link to these templates?

Maybe I can symlink the templates into Sphinx, let me try that.

The templates are versioned by virtue of them being in the repo? You can see e.g. blame from numerous changes to the bug report template here:
https://github.com/numba/numba/blame/master/.github/ISSUE_TEMPLATE/Bug_report.md

or do you mean something else?

The templates are versioned by virtue of them being in the repo? You can see e.g. blame from numerous changes to the bug report template here:
https://github.com/numba/numba/blame/master/.github/ISSUE_TEMPLATE/Bug_report.md

or do you mean something else?

I wasn't aware that this is how tempaltes worked. I though they were simply attached to the repo in an unversioned form. Thank you for clearing this up.

No problem. What's also quite nice about maybe doing it this way is that you don't have to expose the template in the https://github.com/numba/numba/blob/master/.github/ISSUE_TEMPLATE/config.yml (as it's not useful to users) but I think it's still accessible directly as needed. E.g. by accessing:

https://github.com/numba/numba/issues/new?template=THE_RELEASE_TEMPLATE.md

That is useful, I have included such URLs for both templates.

This makes the templates available from the menu to open issues. It also displays a description and the template itself as part of the Sphinx based documentation.

esc · 2021-05-03T13:55:11Z

@stuartarchibald I have managed to convert the plain text templates to proper Github templates. I added the suffix (Maintainer Only) to the description for now, as I haven't yet found the documentation about hiding issue templates (I am not even sure it is possible).

esc · 2021-05-04T12:48:16Z

@stuartarchibald I have trawled the Github documentation some more and have not discovered a setting for config.yml which allows us to hide specific issue templates and make them accessible only via the query parameters of a URL. I think the sufffix (Maintainer Only) may have to be "good enough for now". I could use ALL CAPS to emphasize this some more, but I'd rather we wait to resort to such extreme measures until it becomes absolutely necessary.

stuartarchibald

Thanks for the patch, great to see this recorded and made easy to do.

stuartarchibald · 2021-05-05T09:04:45Z

+While this worked OKish for many years, often times tasks were lost during
+repeated copy and paste. As a result this document was created to keep track of
+all potential tasks. All templates within this document are written in Github
+Markdown and are available as issue templates on Github. This means,


Why are they called .yml as files in the doc source tree if they are markdown .md?

Because the format of the templates is such that you write markdown for the template content and then wrap that in yaml to add metadata such as title etc...

So, this piece of documentation threw me off:

Issue templates are stored on the repository's default branch, in a hidden .github/ISSUE_TEMPLATE directory. If you create a template in another branch, it will not be available for collaborators to use. Issue template filenames are not case sensitive, and need a .md extension. To be included in the community profile checklist, issue templates must be located in the .github/ISSUE_TEMPLATE folder and contain valid name: and about: YAML front matter.

From: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates

Will rename the files to .md.

Tweaking some language, consistency and formatting bits. Co-authored-by: stuartarchibald <stuartarchibald@users.noreply.github.com>

As title

esc · 2021-05-21T07:39:53Z

@stuartarchibald thank you for your review. I have addressed most issues and left a few comments on items where we need to find consensus. Happy to see this moving closer to the finish line.

As title

stuartarchibald

Thanks for the updates. Few minor suggestions else looks good.

As title. Co-authored-by: stuartarchibald <stuartarchibald@users.noreply.github.com>

As title

stuartarchibald

Thanks for all your efforts on this, patch looks good!

esc · 2021-06-15T16:13:22Z

@stuartarchibald thank you for the feedback, I have included all suggestions now and also added the full-stops and capitals as per our OOB conversation.

document release checklist

fc54ea5

This adds documentation and templates for the Numba release process.

esc requested review from sklam and stuartarchibald as code owners April 30, 2021 14:33

esc added doc 3 - Ready for Review labels Apr 30, 2021

esc added this to the Numba 0.54 RC milestone Apr 30, 2021

stuartarchibald reviewed Apr 30, 2021

View reviewed changes

move templates to github template issues

821299c

This makes the templates available from the menu to open issues. It also displays a description and the template itself as part of the Sphinx based documentation.

stuartarchibald reviewed May 5, 2021

View reviewed changes

stuartarchibald added 4 - Waiting on author Waiting for author to respond to review and removed 3 - Ready for Review labels May 5, 2021

esc and others added 4 commits May 21, 2021 09:29

Apply suggestions from code review

93b25bf

Tweaking some language, consistency and formatting bits. Co-authored-by: stuartarchibald <stuartarchibald@users.noreply.github.com>

clarify bullet about updating the release checklist

b153c84

As title

make a sublist as a stub for all PRs to be be cherry-picked

98a8bef

As title

clarify that any changes to master must be done via PR

34f0949

As title

esc added 4 commits June 2, 2021 18:47

fix title length

7639be6

As title

mention the GitHub link to open new issues

3ff2b4a

As title

rewire template files

d1faf06

As title

fix rc indexing within the template

b7c6bbf

As title

esc added 4 - Waiting on reviewer Waiting for reviewer to respond to author and removed 4 - Waiting on author Waiting for author to respond to review labels Jun 14, 2021

stuartarchibald reviewed Jun 14, 2021

View reviewed changes

stuartarchibald added 4 - Waiting on author Waiting for author to respond to review Effort - long Long size effort needed and removed 4 - Waiting on reviewer Waiting for reviewer to respond to author labels Jun 14, 2021

esc and others added 2 commits June 15, 2021 09:15

Apply suggestions from code review

f3a8401

As title. Co-authored-by: stuartarchibald <stuartarchibald@users.noreply.github.com>

adding full-stops to bullets

077c896

As title

stuartarchibald approved these changes Jun 15, 2021

View reviewed changes

stuartarchibald added 5 - Ready to merge Review and testing done, is ready to merge and removed 4 - Waiting on author Waiting for author to respond to review labels Jun 15, 2021

sklam merged commit 748b097 into numba:master Jun 15, 2021

esc deleted the document_release_checklist branch July 20, 2021 11:00

Conversation

esc commented Apr 30, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

esc commented May 3, 2021

Uh oh!

esc commented May 4, 2021

Uh oh!

stuartarchibald left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

esc commented May 21, 2021

Uh oh!

stuartarchibald left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartarchibald left a comment

Choose a reason for hiding this comment

Uh oh!

esc commented Jun 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants