Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Release 0.37.0#3533

Merged
akaszynski merged 3 commits into
mainfrom
release/0.37
Nov 1, 2022
Merged

Release 0.37.0#3533
akaszynski merged 3 commits into
mainfrom
release/0.37

Conversation

@akaszynski
Copy link
Copy Markdown
Member

@akaszynski akaszynski commented Nov 1, 2022 •
edited
Loading

Release 0.37.0

  • Bump main to 0.38.dev0 (this PR)
  • Keep this branch (release/0.37) and update the version to 0.37.0. And commit the change to this branch.
  • Tag v0.37.0 and push the tag.
  • Verify docs and PyPI have updated.
  • Update the conda-forge feedstock.

Release Notes Preview

What's Changed

Breaking Changes

New Features

Bug fixes or behavior changes

Documentation

Maintenance PRs

New Contributors

@codecov
Copy link
Copy Markdown

codecov Bot commented Nov 1, 2022 •
edited
Loading

Codecov Report

Merging #3533 (ec60812) into main (7195d44) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #3533   +/-   ##
=======================================
  Coverage   95.16%   95.16%           
=======================================
  Files          83       83           
  Lines       18571    18571           
=======================================
  Hits        17674    17674           
  Misses        897      897

@adeak
Copy link
Copy Markdown
Member

adeak commented Nov 1, 2022 •
edited
Loading

Shouldn't the title be

Release 0.37.0

? And is there a release notes preview somewhere?

@akaszynski akaszynski changed the title Release 0.38.0 Release 0.37.0 Nov 1, 2022
@akaszynski
Copy link
Copy Markdown
Member Author

akaszynski commented Nov 1, 2022

Shouldn't the title be

Release 0.37.0

? And is there a release notes preview somewhere?

Correct on both accounts:

  • Title has been corrected.
  • Release notes preview has been generated. The trick to do this is to create a new release, specify a new temporary tag, and generate the release notes relative to the last minor release (in this case, v0.36.0).

@adeak
Copy link
Copy Markdown
Member

adeak commented Nov 1, 2022 •
edited
Loading

Some thoughts after perusing the release notes draft (thanks!):

  1. In Rename method: overwrite -> copy_from #3230 we deprecated overwrite, it's still available but raises a warning. Do I understand correctly that we should only mark it as "breaking change" when we decide to remove this entirely?
  2. I was going to point out that in Add area to DataSet and make pointgrid volume exact #3160 we changed pointgrid volume calculation to be better (different algorithm, seems to be faster, and more exact). And I was going to ask if we should note somewhere that the exact values from the filter will silently change. But now that I'm looking at the diff again it's not clear to me where this supposed change in behaviour is coming from... (cc @MatthewFlamm)
  3. Regarding the release notes preview in the PR comment: not a huge deal, but the folded "maintenance" section has broken markdown. Will the final release notes have the same format, and if yes, can we fix it?
  4. Still regarding the release notes: there's a tiny, folded "Details" section at the bottom, which actually hides the "New Contributors" list. It would be nice to have this unfolded by default to praise our newcomers :)

@akaszynski
Copy link
Copy Markdown
Member Author

akaszynski commented Nov 1, 2022

Still regarding the release notes: there's a tiny, folded "Details" section at the bottom, which actually hides the "New Contributors" list. It would be nice to have this unfolded by default to praise our newcomers :)

Good catch. This was only mean to hide dependabot PRs from taking all the credit.

@akaszynski
Copy link
Copy Markdown
Member Author

akaszynski commented Nov 1, 2022

Regarding the release notes preview in the PR comment: not a huge deal, but the folded "maintenance" section has broken markdown. Will the final release notes have the same format, and if yes, can we fix it?

Fixed as well.

@adeak
Copy link
Copy Markdown
Member

adeak commented Nov 1, 2022

Regarding the release notes preview in the PR comment: not a huge deal, but the folded "maintenance" section has broken markdown. Will the final release notes have the same format, and if yes, can we fix it?

Fixed as well.

Thanks! It would be nice if at one point in the future we could factor out dependabot and similar auto-PRs specifically for hiding. Now we have stuff like #2964 (which is a fairly major refactor) and #3396 (which is the PR of a new contributor) which are indeed "maintenance" but would be nice to see directly in the release notes.

@akaszynski
Copy link
Copy Markdown
Member Author

akaszynski commented Nov 1, 2022

Do I understand correctly that we should only mark it as "breaking change" when we decide to remove this entirely?

After reading through #3032, I don't think we specified what a breaking change was. There's a continuum of definitions from everything, to the narrower definition of "potentially causes other components to fail". I'd say anything that we can't make backwards compatible without a least a warning (e.g. #3431), is a "breaking change", like changing the Python print statement from 2 to 3.

Yes we should document it. No, not this release.

@akaszynski
Copy link
Copy Markdown
Member Author

akaszynski commented Nov 1, 2022

Thanks! It would be nice if at one point in the future we could factor out dependabot and similar auto-PRs specifically for hiding. Now we have stuff like #2964 (which is a fairly major refactor) and #3396 (which is the PR of a new contributor) which are indeed "maintenance" but would be nice to see directly in the release notes.

We should probably just ignore dependabot and github-actions in future release notes (if possible) in release.yml. I've deleted them here since many maintenance PRs are helpful.

@akaszynski
Copy link
Copy Markdown
Member Author

akaszynski commented Nov 1, 2022

Only remaining item is:

I was going to point out that in Add area to DataSet and make pointgrid volume exact #3160 we changed pointgrid volume calculation to be better (different algorithm, seems to be faster, and more exact). And I was going to ask if we should note somewhere that the exact values from the filter will silently change. But now that I'm looking at the diff again it's not clear to me where this supposed change in behaviour is coming from... (cc @MatthewFlamm)

I'm not going to block the release for it, but we might want to point this out somewhere.

adeak
adeak approved these changes Nov 1, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@adeak adeak left a comment

Choose a reason for hiding this comment

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

Approving pending potential action regarding #3160. Thanks for the quick adjustments @akaszynski!

@akaszynski
Copy link
Copy Markdown
Member Author

akaszynski commented Nov 1, 2022

Approving pending potential action regarding #3160. Thanks for the quick adjustments @akaszynski!

After some sleuthing, made a note here. Forgot that @MatthewFlamm did this and it's a good fix.

@akaszynski akaszynski enabled auto-merge (squash) November 1, 2022 23:18
@MatthewFlamm
Copy link
Copy Markdown
Contributor

MatthewFlamm commented Nov 1, 2022

But now that I'm looking at the diff again it's not clear to me where this supposed change in behaviour is coming from...

I view the changes in #3160 as fixing a bug although I agree it is on the continuum of a breaking change. If the user wants the volume for those data types, it now provides the exact volume rather than an approximate volume.

The change occurred by removing the overriding method that used the approximate volume.

@adeak
Copy link
Copy Markdown
Member

adeak commented Nov 1, 2022

Thank you both!

@akaszynski akaszynski merged commit a9d2186 into main Nov 1, 2022
@akaszynski akaszynski deleted the release/0.37 branch November 1, 2022 23:30
@akaszynski akaszynski restored the release/0.37 branch November 1, 2022 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@adeak adeak adeak approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

release

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@akaszynski @adeak @MatthewFlamm