Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Backport bugfix PRs to the 6.1.x release branch #1251

Merged
merged 11 commits into from
Jul 21, 2020
Merged

Backport bugfix PRs to the 6.1.x release branch #1251

merged 11 commits into from
Jul 21, 2020

Conversation

mdickinson
Copy link
Member

@mdickinson mdickinson commented Jul 21, 2020 •
edited
Loading

This PR against the release/6.1.x branch:

The PR backports were all done using git cherry-pick -x <commit_hash>, with the commit hash referring to the merge commit for the corresponding PR against master.

mdickinson and others added 11 commits July 21, 2020 11:34
@mdickinson
Fix end-year in copyright statement (#1198)
155fbb4 
(cherry picked from commit 21e2a99)
@mdickinson
Fix trait-documenter extension tests for Sphinx 3.1 (#1206)
82173cb 
(cherry picked from commit aeaf72f)
@kitchoi @mdickinson
DOC/FIX: User manual mentioning a nonexisting feature in metadata fil…
e1a6c4d 
…ter (#1207)

* Fix user manual erroneously mentioning a nonexisting feature

* Fix grammar

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
(cherry picked from commit 3e78a41)
@kitchoi @mdickinson
Spelling and grammar. (#1210)
d133166 
(cherry picked from commit 24c4d76)
@mdickinson
Fix description in README to match the one in the setup script (#1219)
6f7d8c6 
(cherry picked from commit a5dc3f2)
@mdickinson
Fix some missing stubs (#1204)
0139073 
* Add a couple of missing imports to api.pyi

* Remove mis-spelled stubs file

* Add missing api.pyi stubs for the has_traits module

* Add CTrait

* Add imports for BaseTraitHandler and TraitHandler

* Add constants

(cherry picked from commit 47806c8)
@mdickinson
Standardize copyright years (#1227)
a62ad66 
* Standardize copyright years

* Use hard-coded year in conf.py, for ease of later search-and-replace. Also normalise punctuation.

* More punctuation OCD

* More consistency fixes

* Remove unused import

* Remove the _right_ unused import

* Yet one more consistency fix

(cherry picked from commit aa63531)
@mdickinson
Don't mutate global state at import time in a test module (#1222)
a619015 
(cherry picked from commit 24345a1)
@mdickinson
Fix typo in optional_dependencies (#1235)
680c938 
Fix a comment that mistakenly refers to traits.api, when it means traitsui.api.

(cherry picked from commit a48ede5)
@mdickinson
Update PyPI links and capitalization in README.rst (#1250)
9455411 
* Update PyPI links and capitalization in README.rst

This PR:
- updates incorrect and inconsistent capitalization in the README
- adds a PyPI link for Sphinx
- adds a PyPI link for the Enthought Sphinx Theme (the previous link was to GitHub)

* Clarify that later versions  of Sphinx are fine

* Update README.rst

(cherry picked from commit 8d03955)
@mdickinson
Update changelog
81e5776
@mdickinson mdickinson mentioned this pull request Jul 21, 2020
Closed
rahulporuri
rahulporuri approved these changes Jul 21, 2020
View reviewed changes
Copy link
Contributor

@rahulporuri rahulporuri left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM but for the one missing changelog entry needs to read the PR description clearly

@mdickinson
Copy link
Member Author

Thanks for reviewing. The missing changelog entry is deliberate: that's a traits-stubs fix rather than a traits fix, so belongs in the traits-stubs changelog (which doesn't exist yet, but will need to be brought into existence when we next make a release of traits-stubs).

@rahulporuri
Copy link
Contributor

Just to confirm, a 6.1.1 of traits also means a 6.1.1 of traits-stubs? If not, I'm not sure why the traits-stubs PR was backported.

@mdickinson
Copy link
Member Author

Just to confirm, a 6.1.1 of traits also means a 6.1.1 of traits-stubs?

No, not necessarily. We don't need to align traits releases and traits-stubs releases, but at some point a traits-stubs bugfix release will likely be made from the release/6.1.x branch.

If not, I'm not sure why the traits-stubs PR was backported.

Because it'll eventually need to be backported (for the next time we make a traits-stubs release), and it's convenient to do all the existing backports at once.

@mdickinson
Copy link
Member Author

We don't need to align traits releases and traits-stubs releases

To be clear, we need to align for <major.minor> versions, but not for micro (bugfix) versions: the Traits API doesn't change in bugfix releases, so there's no necessity for an aligned traits-stubs release. Conversely, there may be traits-stubs fixes that we want to release in a traits-stubs bugfix release but that don't affect Traits: in that situation, we don't want to have to make a Traits release just to keep version numbers aligned.

@mdickinson
Copy link
Member Author

And the real takeaway from this is that attempting to maintain multiple packages in a single repository is painful. It's much easier if each package has its own commit graph.

@mdickinson mdickinson merged commit 76ecb14 into release/6.1.x Jul 21, 2020
@mdickinson mdickinson deleted the pr-backports branch July 21, 2020 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rahulporuri rahulporuri rahulporuri approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mdickinson @rahulporuri @kitchoi