question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Document towncrier rendering release process

See original GitHub issue

(This is a “sub-issue” of #11847)

In v4.3 I did a very awkward towncrier approach, but we should update the release instructions with a better process. Here’s a proposal @bsipocz , @Cadair, @pllim and I discussed out-of-band in an infrastructure telecon:

  1. At the time of an RC, the release manager should look over the rendered changelog and look for issues like things being in the wrong section or changelog entries being too long. If they see issues, they should ask the maintainer “can you shorten or maybe put this in the what’s new? please make the PR to do that into main, and we’ll backport to the release branch” But they should not run towncrier to clean up the fragments for an RC
  2. As a “last before release” (i.e., within 24 hr or so of release) step, the release manager should make a PR into the release branch that runs towncrier. It should then be merged just before released.
  3. As a post-release step, the commit from step 2 should be forward-ported to main

For bugfix releases, just do 2-3, although the release manager may want to do some of the step 1 items in a PR just before release.

If we agree with that process, this should get written up into the release procedures docs.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:2
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
saimncommented, Jul 26, 2021

The process seems fine to me. We should try to improve things before PRs are merged, so maybe add some instructions in https://github.com/astropy/astropy/blob/main/docs/changes/README.rst about using a concise style and maybe some guidelines as well on the expected phrasing ? There is already an example but it comes from Numpy and does not reflect our expectations I think.

0reactions
astrofrogcommented, Feb 17, 2022

The release docs have been refactored in https://github.com/astropy/astropy/pull/12755 and I think towncrier is now adequately described. Please feel free to open a follow-up issue or PR if the current towncrier instructions are not sufficient.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Document towncrier rendering release process issue ... - Python 博客
In v4.3 I did a very awkward towncrier approach, but we should update the release instructions with a better process. Here's a proposal...
Read more >
Configuration Reference - Towncrier 22.8.1.dev0 documentation
All configuration for towncrier sits inside pyproject.toml , under the ... the release notes should start. .. towncrier release notes start by default....
Read more >
towncrier assumes working on a python package #320 - GitHub
I have python project, but the in release process I have a script that does various other things to prepare the release, including...
Read more >
Release procedure for the astropy core package
This page describes the release process for the core astropy package. ... Do not render the changelog with towncrier at this point. This...
Read more >
Town Crier: An Authenticated Data Feed for Smart Contracts
envisioned as a way to render legal agreements more precise, ... Intel's recently released trusted hardware capability, and a smart-contract front end.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found