Skip to content

Release notes and changelog for 6.1.0#1133

Merged
mdickinson merged 27 commits into
masterfrom
doc/changelog-for-6.1
May 22, 2020
Merged

Release notes and changelog for 6.1.0#1133
mdickinson merged 27 commits into
masterfrom
doc/changelog-for-6.1

Conversation

@mdickinson
Copy link
Copy Markdown
Member

@mdickinson mdickinson commented May 21, 2020

Building on @kitchoi's work, here's a first draft of release notes and changelog.

There's a bit of duplication between the prose version of the changes and the PR-by-PR version, especially with respect to the deprecations. I'm not sure how best to combine them, or whether to leave as-is.

Closes #1101.

For future use, here's the quick-and-dirty Python script I'm using to check for missing changelog entries:

import re
import subprocess

cmd = ["git", "log", "6.0.0..origin/master", "--pretty=* %s"]
git_log = subprocess.check_output(cmd).decode("utf-8")

pr_numbers = {
    re.search(r"\((#\d+)\)$", log_entry).group(1): log_entry
    for log_entry in git_log.splitlines()
}

with open("CHANGES.rst", "r", encoding="utf-8") as f:
    changelog = f.read()

for pr_number in pr_numbers:
    if pr_number not in changelog:
        print("Missing PR: ", pr_numbers[pr_number])

Comment thread CHANGES.rst
Release 6.1.0
-------------

Released: 2020-05-XX
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be updated upon actual release; there's already an entry in the release checklist to remind us to do this.

Comment thread CHANGES.rst Outdated
Comment thread CHANGES.rst Outdated
Comment thread CHANGES.rst Outdated
Comment thread CHANGES.rst Outdated
mdickinson and others added 3 commits May 21, 2020 15:41
Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com>
@mdickinson
Copy link
Copy Markdown
Member Author

This is mostly done, but:

Comment thread CHANGES.rst Outdated
Comment thread CHANGES.rst Outdated
Copy link
Copy Markdown
Contributor

@kitchoi kitchoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Two minor suggestions.

Comment thread CHANGES.rst Outdated
Comment thread CHANGES.rst Outdated
Copy link
Copy Markdown
Contributor

@kitchoi kitchoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great!

Comment thread CHANGES.rst Outdated
#1080, #1082, #1079, #1071, #1072, #1075, #1085, #1089, #1078, #1093, #1086,
#1077, #1095, #1102, #1108, #1110, #1112, #1117, #1118, #1123, #1125, #1126,
#1128, #1129, #1135)
* Make ``DefaultValue``, ``ValidateTrait`` and ``TraitKind`` available in
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change was already present in 6.0.

Comment thread CHANGES.rst Outdated
(#926)
* Fix exception swallowing by Trait attribute access. (#959, #960)
* Allow collections in valid values for ``Enum`` trait. (#889)
* Avoid containment-related ``DeprecationWarning`` on Python 3.7 (#855)
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#855 went into Traits 6.0; removing here

Comment thread CHANGES.rst Outdated
Documentation
~~~~~~~~~~~~~

* Improved API documentation for ``trait_types``. (#843)
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already in 6.0.

@mdickinson mdickinson added the component: documentation Issues related to the Sphinx documentation label May 22, 2020
@mdickinson mdickinson merged commit 7fca7e5 into master May 22, 2020
@mdickinson mdickinson deleted the doc/changelog-for-6.1 branch May 22, 2020 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: documentation Issues related to the Sphinx documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Traits 6.1 release announcement: details

2 participants