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

fix(docs): add dynamic versioning to docs build #353

Merged
merged 1 commit into from
Nov 7, 2023

Conversation

kenibrewer
Copy link
Member

@kenibrewer kenibrewer commented Nov 2, 2023

Description

This change will ensure that RTD docs in the latest section will more correctly display a version such as 1.0.0.post7.dev0+g29045e8 when the main branch contains 7 un-released commits instead of continuing to display 1.0.0.

This introduces the dunamai docs dependency which is already an indirect dependency for our build process. poetry-dynamic-versioning uses dunamai to calculate the appropriate version strings.

Closes #352

What is the nature of your change?

  • Bug fix (fixes an issue).

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 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.

📚 Documentation preview 📚: https://pycytominer--353.org.readthedocs.build/en/353/

@kenibrewer kenibrewer self-assigned this Nov 2, 2023
@codecov-commenter
Copy link

Codecov Report

Merging #353 (2b00a71) into main (015db95) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #353   +/-   ##
=======================================
  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

@kenibrewer kenibrewer marked this pull request as ready for review November 3, 2023 13:44
@kenibrewer kenibrewer requested a review from d33bs November 6, 2023 14:54
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.

Nice @kenibrewer ! This makes it more clear the earlier changes you had made to this effect (apologies about the issues which arose as part of my suggestions!). Things look good to me here.

@kenibrewer kenibrewer merged commit a8e6ca9 into cytomining:main Nov 7, 2023
10 checks passed
@kenibrewer kenibrewer deleted the docs/dynamic-version branch November 7, 2023 13:27
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.

Bug: RTD docs for latest doesn't show if it contains unreleased changes
3 participants