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

chore: cleanup VCS versioning #999

Merged
merged 1 commit into from Jan 19, 2024

Conversation

Saransh-cpp
Copy link
Contributor

Ran into a few developer issues while installing locally and decided to inspect pyproject.toml -

  • hatch-vcs uses setuptools_scm underneath, so it is not required to list down setuptools_scm's config in pyproject.toml (this was redundant anyways, given that the hatch-vcs config was given preference)
  • The path of the version file is automatically picked up by hatch-vcs
  • The version file (_version.py) should not be tracked by version control
  • setuptools_scm suggests using the name _version.py and not version.py
  • version.pyi defines the structure of the version (this is optional and can be removed, but it is always nice to have one)

I hope these things were not intentional.

@lgray
Copy link
Collaborator

lgray commented Jan 19, 2024

Not intentional, thanks for cleaning it up!

@lgray
Copy link
Collaborator

lgray commented Jan 19, 2024

@Saransh-cpp if you're done here I'll turn on auto-merge. Please let me know either way.

@Saransh-cpp
Copy link
Contributor Author

This should be ready to merge!

@lgray lgray merged commit ad1ec43 into CoffeaTeam:master Jan 19, 2024
14 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.

None yet

2 participants