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

Fetch docsite version number from git tags #675

Merged
merged 1 commit into from
Aug 1, 2023
Merged

Conversation

ebezzi
Copy link
Member

@ebezzi ebezzi commented Aug 1, 2023

Instead of getting the version from the (local) census version, just get the most recent tag from git. This will match the latest released version.

Copy link
Contributor

@bkmartinjr bkmartinjr left a comment

Choose a reason for hiding this comment

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

Does this assume that the git tag is the correct version for all docs? I was under the impression @pablo-gar was still trying to decide if he wants one version or multiple versions.

Approving on the assumption that this decision has been taken, as code looks good.

@ebezzi
Copy link
Member Author

ebezzi commented Aug 1, 2023

Does this assume that the git tag is the correct version for all docs? I was under the impression @pablo-gar was still trying to decide if he wants one version or multiple versions.

Approving on the assumption that this decision has been taken, as code looks good.

The current docsite setup doesn't allow for multiple version. We'd need to switch back to readthedocs or use a sphinx plugin for that. This PR merely ensures that no "dev" tags will be added to the version number in the docsite when we build it from main.

@bkmartinjr
Copy link
Contributor

The current docsite setup doesn't allow for multiple version

I meant different versions for Python & R packages, and perhaps even another for data docs. But I take your point that this is a problem for another day!

@codecov
Copy link

codecov bot commented Aug 1, 2023

Codecov Report

Merging #675 (359a49b) into main (5600fbf) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #675   +/-   ##
=======================================
  Coverage   87.06%   87.06%           
=======================================
  Files          65       65           
  Lines        4493     4493           
=======================================
  Hits         3912     3912           
  Misses        581      581           
Flag Coverage Δ
unittests 87.06% <ø> (ø)

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
Collaborator

@atolopko-czi atolopko-czi left a comment

Choose a reason for hiding this comment

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

LGTM.

Is there an associated issue to link to?

@pablo-gar
Copy link
Contributor

I meant different versions for Python & R packages, and perhaps even another for data docs. But I take your point that this is a problem for another day!

Python and R will have mirrored versions. Data docs are currently not versioned (which we either need to do or make a good effort to create good changelogs)

@ebezzi ebezzi merged commit 5a31491 into main Aug 1, 2023
12 checks passed
@ebezzi ebezzi deleted the ebezzi/docsite-tagname branch August 1, 2023 17:05
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.

4 participants