Release instructions #317

altendky · 2021-01-17T17:23:48Z

No description provided.

codecov · 2021-01-17T17:24:40Z

Codecov Report

Merging #317 (bfb7611) into master (00f19b4) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #317   +/-   ##
=======================================
  Coverage   96.78%   96.78%           
=======================================
  Files          20       20           
  Lines        1183     1183           
  Branches      106      106           
=======================================
  Hits         1145     1145           
  Misses         20       20           
  Partials       18       18

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 00f19b4...bfb7611. Read the comment docs.

CONTRIBUTING.rst

altendky · 2021-01-17T18:24:20Z

CONTRIBUTING.rst

+
+- Once the final release has been made, leave the approving review intact and merge the PR.
+
+# TODO: should we have an indicator on the version for interrim development or just leave the last release version intact?


Probably ought to just leave this for a separate activity I guess. It isn't needed to do a release and isn't presently being done at all.

Good question. I think that we should have a placeholder like. "No changes since last release."

For my project, I do a stupid think and replace the release candidate in the release notes with the final note.
But this erases the project history and I think it's bad practice.

In my fork of towncrier, If I run towncrier with a new version and no news fragments I get an em

But we can have something like this for the default template

{% set underline = "^" %} {% set section = sections[''] %} {% set empty_release = True %} {% for category, val in definitions.iteritems()%} {% if definitions[category]['showcontent'] and section[category]|length > 0 %} {{ definitions[category]['name'] }} {{ underline * definitions[category]['name']|length }} {% for text, values in section[category]|dictsort(by='value') %} * {{ text }} {{ values|sort|join(', ') }} {% set empty_release = False %} {% endfor %} {% endif %} {% endfor %} {% if empty_release %} No changes since the last release. {% endif %}

To produce something like

Version 4.8.0, 2021-02-01 ------------------------- No changes since the last release. Version 4.8.0rc1, 2020-11-19 ------------------------- New Features ^^^^^^^^^^^^ * The embedded OpenSSL libraries used on Windows, macOS, and generic Linux were updated to version 1.1.1h. [#5496]

I was referring to the project version, unrelated to generating release notes. Rather, if I checkout and install an arbitrary commit of towncrier I will get one claiming to be the last release version since after doing a release the version is just left alone.

Despite having numerous changes since the release of 19.2, the latest commit on master still claims to be 19.2.

https://github.com/twisted/towncrier/blame/00f19b4d24ad5dfd57124f7c93f9ba2107408f8c/src/towncrier/_version.py#L10

adiroiban

just initial comments

CONTRIBUTING.rst

adiroiban

Looks like a very good start. Thanks. I left my comments.
You are the boss so feel free to do it as you like :)

altendky

To keep master up to date, perhaps the release branch should be merged back into master not only at the end but also after each pre-release? Any pre-release ought to exist in the history even if something drastic is changed about it so I'm not sure in what case a released commit should not exist in master or why it's merging should wait. If this is good, the existing post-final-release step to merge would be shifted to apply after every release.

CONTRIBUTING.rst

altendky · 2021-02-02T16:58:20Z

CONTRIBUTING.rst

+
+- Once the final release has been made, leave the approving review intact and merge the PR.
+
+# TODO: should we have an indicator on the version for interrim development or just leave the last release version intact?


I was referring to the project version, unrelated to generating release notes. Rather, if I checkout and install an arbitrary commit of towncrier I will get one claiming to be the last release version since after doing a release the version is just left alone.

Despite having numerous changes since the release of 19.2, the latest commit on master still claims to be 19.2.

https://github.com/twisted/towncrier/blame/00f19b4d24ad5dfd57124f7c93f9ba2107408f8c/src/towncrier/_version.py#L10

Co-authored-by: Adi Roiban <adiroiban@gmail.com>

adiroiban · 2021-02-03T00:37:42Z

To keep master up to date, perhaps the release branch should be merged back into master not only at the end but also after each pre-release?

I would say it's not worth the trouble.
But it's your call :)

I was referring to the project version, unrelated to generating release notes. Rather, if I checkout and install an arbitrary commit of towncrier I will get one claiming to be the last release version since after doing a release the version is just left alone.

Sorry for missing that.

Yes. I think that after the public release there should another step to update the release to +1 and + .dev0

so if 21.1.0 was release, after the release the release branch is updated with 21.1.1dev0 and merged into master.

For a 2.1.2 release... it will be updated to 2.1.3dev0

altendky · 2021-02-04T03:07:24Z

this is getting painful... not complaining about your reviews, just the detail and growth of the process and a minimum of triplicate reviews and dismissing reviews and... the review dismissals make me wonder if it would be simpler to treat each sub-release via a separate PR against the release branch. sounds complicated, also sounds simpler since you wouldn't dismiss reviews. anyways. :|

adiroiban · 2021-02-04T09:30:56Z

CONTRIBUTING.rst

+
+  - Return to the towncrier build step and continue.
+
+- If the final release has been completed, continue below.


Maybe keep it simple.

I don't think that we need to go into the edit src/towncrier/_version.py as by this point people should know how do update the version.

Suggested change

- If the final release has been completed, continue below.

- If the final release has been completed, mark current version as development `Version('towncrier', 19, 9, 1, dev=0)`` and merge it without requesting another review.

I'll drop the review requirement but I don't feel that not stating what to do makes the instructions simpler. Seems mostly just inconsistent with the rest of the instructions.

altendky · 2021-02-04T13:55:00Z

CONTRIBUTING.rst

+
+  - Return to the towncrier build step and continue.
+
+- If the final release has been completed, continue below.


I'll drop the review requirement but I don't feel that not stating what to do makes the instructions simpler. Seems mostly just inconsistent with the rest of the instructions.

CONTRIBUTING.rst

adiroiban

All good. Thanks!

I think that having a single PR is easier. I guess that we can give it a try and see if things get ugly.. .then the process can be changed with a PR for each release and separate PR for each release candidates.

I think the title of this PR can be updated and this PR merged .

Looking forward to the next release where we can practice what is documented here.

Many thanks again for putting this together.

altendky · 2021-02-05T02:03:14Z

Thanks for seeing it through with the reviews.

altendky added 2 commits January 17, 2021 12:23

preliminary release instructions

869b941

Merge branch 'master' into release_process_documentation

4f34052

altendky added 2 commits January 17, 2021 12:36

Add helper script to canonicalize versions

312f08d

manifest

dba7e98

altendky commented Jan 17, 2021

View reviewed changes

altendky requested a review from adiroiban January 17, 2021 18:27

altendky mentioned this pull request Jan 17, 2021

Release planning (19.9.0rc1, 19.9.0, and 21.3.0) #313

Closed

18 tasks

adiroiban reviewed Feb 1, 2021

View reviewed changes

adiroiban requested changes Feb 1, 2021

View reviewed changes

altendky commented Feb 2, 2021

View reviewed changes

Apply suggestions from code review

1995d32

Co-authored-by: Adi Roiban <adiroiban@gmail.com>

altendky added 2 commits February 2, 2021 19:44

Apply suggestions from code review

46a16f1

use dev0 between releases

178025d

altendky marked this pull request as ready for review February 4, 2021 03:07

altendky requested a review from adiroiban February 4, 2021 03:07

adiroiban reviewed Feb 4, 2021

View reviewed changes

altendky commented Feb 4, 2021

View reviewed changes

Apply suggestions from code review

bfb7611

adiroiban approved these changes Feb 5, 2021

View reviewed changes

altendky changed the title ~~Preliminary release instructions~~ Release instructions Feb 5, 2021

altendky merged commit 7f20910 into twisted:master Feb 5, 2021

altendky deleted the release_process_documentation branch February 5, 2021 02:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release instructions #317

Release instructions #317

altendky commented Jan 17, 2021

codecov bot commented Jan 17, 2021 •

edited

Loading

altendky Jan 17, 2021

adiroiban Feb 1, 2021

altendky Feb 2, 2021

adiroiban left a comment

adiroiban left a comment

altendky left a comment

altendky Feb 2, 2021

adiroiban commented Feb 3, 2021

altendky commented Feb 4, 2021

adiroiban Feb 4, 2021

altendky Feb 4, 2021

altendky Feb 4, 2021

adiroiban left a comment

altendky commented Feb 5, 2021


		- Once the final release has been made, leave the approving review intact and merge the PR.

		# TODO: should we have an indicator on the version for interrim development or just leave the last release version intact?


		- Return to the towncrier build step and continue.

		- If the final release has been completed, continue below.

Release instructions #317

Release instructions #317

Conversation

altendky commented Jan 17, 2021

codecov bot commented Jan 17, 2021 • edited Loading

Codecov Report

altendky Jan 17, 2021

Choose a reason for hiding this comment

adiroiban Feb 1, 2021

Choose a reason for hiding this comment

altendky Feb 2, 2021

Choose a reason for hiding this comment

adiroiban left a comment

Choose a reason for hiding this comment

adiroiban left a comment

Choose a reason for hiding this comment

altendky left a comment

Choose a reason for hiding this comment

altendky Feb 2, 2021

Choose a reason for hiding this comment

adiroiban commented Feb 3, 2021

altendky commented Feb 4, 2021

adiroiban Feb 4, 2021

Choose a reason for hiding this comment

altendky Feb 4, 2021

Choose a reason for hiding this comment

altendky Feb 4, 2021

Choose a reason for hiding this comment

adiroiban left a comment

Choose a reason for hiding this comment

altendky commented Feb 5, 2021

codecov bot commented Jan 17, 2021 •

edited

Loading