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

Add poetry dynamic versioning and update release process #132

Merged
merged 10 commits into from
Dec 20, 2023

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Dec 19, 2023

Description

This PR adds dynamic versioning changes intended to eventually assist with #19 by adding CytoTable version metadata into Parquet output. The goal is to enable dynamic version capture in both development (git source-based) and published releases (PyPI, etc), meaning data created by CytoTable from either path would be accurately versioned (enhancing data provenance / lineage understanding for audiences). While dunamai and __version__ aren't necessarily required yet, I intend to use them with further changes towards #19 and thought early discussion / review / visibility might assist.

As part of this I had to update the release process and tried to practice DRY better with GitHub Actions during the process. I also updated the pre-commit check versions as a general act of good source-keeping.

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

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 commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

Copy link
Member

@kenibrewer kenibrewer left a comment

Choose a reason for hiding this comment

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

Nice to see this tooling brought to cytotable too! LGTM

@d33bs
Copy link
Member Author

d33bs commented Dec 19, 2023

Thank you @kenibrewer ! Definitely inspired by your great work in Pycytominer! 🙂

@d33bs
Copy link
Member Author

d33bs commented Dec 20, 2023

@kenibrewer , thanks again for your review here! Would you like to be a CytoTable maintainer? I feel that the project could benefit from your insights. If so, let me know and I'll send along an invite.

@d33bs d33bs merged commit 99b8e1f into cytomining:main Dec 20, 2023
7 checks passed
@d33bs d33bs deleted the add-poetry-dynamic-versioning branch December 20, 2023 22:49
@kenibrewer
Copy link
Member

@d33bs Sure! I already watch this repo so I can stay aware of the upstream changes that might impact pycytominer. I'd be happy to provide feedback and insights more formally.

@d33bs
Copy link
Member Author

d33bs commented Dec 21, 2023

Thanks a bunch @kenibrewer - added!

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.

2 participants