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.

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

bump: version 0.2.0 → 1.0.0 #348

Merged
merged 4 commits into from
Nov 1, 2023
Merged

bump: version 0.2.0 → 1.0.0 #348

merged 4 commits into from
Nov 1, 2023

Conversation

kenibrewer
Copy link
Member

@kenibrewer kenibrewer commented Oct 29, 2023

Description

v1.0.0 release of pycytominer

The changelog was initially generated with cz bump --files-only but was manually edited to add the changes that pre-dated adoption of the conventional commit standard.
The changes added to the changelog are summaries of changes relevant to users and key dev processes rather than all changes.

Closes #330

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have deleted all non-relevant text in this pull request template.

@kenibrewer
Copy link
Member Author

@d33bs @gwaybio I would particular appreciate feedback on the changelog in case there's any important changes relevant to users that I missed.

@codecov-commenter
Copy link

codecov-commenter commented Oct 29, 2023

Codecov Report

Merging #348 (c89d651) into main (ea789ba) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #348   +/-   ##
=======================================
  Coverage   95.62%   95.62%           
=======================================
  Files          56       56           
  Lines        3135     3135           
=======================================
  Hits         2998     2998           
  Misses        137      137           
Flag Coverage Δ
unittests 95.62% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Woohoo, v1.0.0! I left a comment which may be way off-base (apologies if so).

Additional considerations:

  • Clarifying for Version 1 release #330 closure: is step 2 accounted for? Mostly here this is a double check that we didn't need to cover more than the poetry build for PyPI / etc.
  1. Minting a release which should be built automatically
  • I recognize it might be forthcoming but wanted to double check on Doc: Add section describing bump and release process #343. Would it make sense to add some material to this PR? Otherwise would a merge now mean the release docs material is technically a part of the next release and not this one?

CHANGELOG.md Show resolved Hide resolved
@kenibrewer
Copy link
Member Author

  • Clarifying for Version 1 release #330 closure: is step 2 accounted for? Mostly here this is a double check that we didn't need to cover more than the poetry build for PyPI / etc.
  1. Minting a release which should be built automatically

Step 2 is accounted for and should happen automatically after drafting the new release.

  • I recognize it might be forthcoming but wanted to double check on Doc: Add section describing bump and release process #343. Would it make sense to add some material to this PR? Otherwise would a merge now mean the release docs material is technically a part of the next release and not this one?

I threw together a quick release guide (based on my anticipated next steps).
My view is that documentation-only changes don't really need to be attached to a release (commitizen excludes docs changes from the CHANGELOG by default).
So if we need to make some tweaks to the release guide I don't think we need to worry about whether that's considered this release or the next.

@kenibrewer kenibrewer requested a review from d33bs October 30, 2023 01:11
Copy link
Member

@gwaybio gwaybio left a comment

Choose a reason for hiding this comment

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

@d33bs - are you able to give this a final look and approval when you're happy? It would be great for you to give this another look if you're able!

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@kenibrewer kenibrewer force-pushed the release-v1.0.0 branch 3 times, most recently from a46713e to c89d651 Compare October 30, 2023 17:17
@kenibrewer kenibrewer marked this pull request as draft October 30, 2023 17:56
@kenibrewer kenibrewer marked this pull request as ready for review October 30, 2023 18:10
@kenibrewer
Copy link
Member Author

@gwaybio @d33bs This is ready for re-review. I fixed the problems with the docs build (and an additional problem with the docs version showing as 0.0.0).

Copy link
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Thank you for the replies to the comments! I've added a few more thoughts to this review for your consideration.

.devcontainer/devcontainer.json Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
@kenibrewer
Copy link
Member Author

@d33bs This ready for review again. I've moved some of the changes you had questions about into separate branches that we can discuss after v1.0.0 release.

Copy link
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Thank you @kenibrewer !

@kenibrewer kenibrewer merged commit 015db95 into main Nov 1, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Version 1 release
4 participants