v1.4 feature freeze + release timeline

Thomas_Kluyver · May 16, 2014, 3:56pm

We already do this in ipython for our ‘whatsnew’ document. We allow arbitrary filenames rather than using PR numbers, and then we concatenate everything from the directory periodically. You’re welcome to copy our script to do this.

Thomas

···

On 16 May 2014 01:17, “Eric Firing” <efiring@…229…> wrote:

Maybe this problem could be reduced by having a directory for CHANGELOG
chunks, one file per PR, with the PR number as the filename. Then at
release time they could be concatenated, edited, appended to the real
CHANGELOG, and deleted.

Paul_Ivanov1 · May 16, 2014, 4:54pm

Thomas Kluyver, on 2014-05-16 08:56, wrote:

···

On 16 May 2014 01:17, "Eric Firing" <efiring@...229...> wrote:
> Maybe this problem could be reduced by having a directory for CHANGELOG
> chunks, one file per PR, with the PR number as the filename. Then at
> release time they could be concatenated, edited, appended to the real
> CHANGELOG, and deleted.

We already do this in ipython for our 'whatsnew' document. We allow
arbitrary filenames rather than using PR numbers, and then we concatenate
everything from the directory periodically. You're welcome to copy our
script to do this.

Yes, this has been working out quite nicely for us, and we
started doing it for the very same reasons - to keep conflicts to
a minimum while making it easier to keep track of everything that
has gone in.

Here's the direct link to our script:

github.com

ipython/ipython/blob/main/tools/update_whatsnew.py

#!/usr/bin/env python
"""Update the What's New doc (development version)

This collects the snippets from whatsnew/pr/, moves their content into
whatsnew/development.rst (chronologically ordered), and deletes the snippets.
"""

import io
import sys
from pathlib import Path
from subprocess import check_call, check_output

repo_root = Path(__file__).resolve().parent.parent
whatsnew_dir = repo_root / "docs" / "source" / "whatsnew"
pr_dir = whatsnew_dir / "pr"
target = whatsnew_dir / "development.rst"

FEATURE_MARK = ".. DO NOT EDIT THIS LINE BEFORE RELEASE. FEATURE INSERTION POINT."
INCOMPAT_MARK = ".. DO NOT EDIT THIS LINE BEFORE RELEASE. INCOMPAT INSERTION POINT."

This file has been truncated. show original

--
                   _
                  / \
                A* \^ -
             ,./ _.`\\ / \
            / ,--.S \/ \
           / `"~,_ \ \
     __o ?
   _ \<,_ /:\
--(_)/-(_)----.../ | \
--------------.......J
Paul Ivanov
http://pirsquared.org