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

Make sure that the version number for a doc build can be computed #507

Merged
merged 2 commits into from
Oct 5, 2022

Conversation

mdickinson
Copy link
Member

The automated documentation build workflow currently miscomputes the version number because GitHub Actions makes a shallow clone without tags, so there's no way to compute the version number from the tags.

This PR fixes that by having the action clone the whole repository.

See also pypa/setuptools-scm#480

@mdickinson
Copy link
Member Author

@mdickinson
Copy link
Member Author

The test run seems to be working, though it's interesting that setuptools_scm chooses to use a version of 1.1.0.dev<nnn> on the fix/... branch. On the main branch, it should be 1.0.0.dev<nnn> as expected. (I've tested this locally.)

@mdickinson
Copy link
Member Author

@rahulporuri Any chance you might have bandwidth for a review?

Copy link
Contributor

@rahulporuri rahulporuri left a comment

Choose a reason for hiding this comment

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

Mostly LGTM

.github/workflows/build-docs.yml Show resolved Hide resolved
@mdickinson mdickinson merged commit d0d1563 into main Oct 5, 2022
@mdickinson mdickinson deleted the fix/doc-build-version-number branch October 5, 2022 14:38
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