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

Auto versioning update #305

Closed
wants to merge 11 commits into from

Conversation

hadijannat
Copy link
Contributor

This PR updates pyproject.toml to use setuptools_scm for automated versioning:

  • Removes static version
  • Adds dynamic = ["version"] to [project] section
  • Configures setuptools_scm

This change allows automatic version management based on Git tags, addressing issue #303.

To use:

  1. Create Git tag: git tag v1.0.1
  2. Push tag: git push --tags

Versions between releases will be like 1.0.1.dev4+g12345.

Please review and suggest any needed changes.

Copy link
Contributor

@s-heppner s-heppner left a comment

Choose a reason for hiding this comment

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

Other than the documentation (comments), it LGTM

.gitignore Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
Clean up .gitignore to include only relevant build artifacts
Added a more detailed comment for the setuptools_scm configuration, explaining its purpose and behavior.
Comment on lines +18 to +21
# Temporary files
*.tmp
*.bak
*.swp
Copy link
Contributor

Choose a reason for hiding this comment

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

Have you encountered this files? I get that if they would exist, we'd want to ignore them, but I personally haven't seen these in Python projects, so if there's no need, I wouldn't add these to the .gitignore.

*.pyc
/.mypy_cache/
# Python build artifacts
__pycache__/
Copy link
Contributor

Choose a reason for hiding this comment

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

I preferred the `**/pycache/ from before, since it matches any pycache directory at any level in the repository. These might occur when you run a module outside of the main directory.

# Python caching
**/__pycache__/
*.pyc
/.mypy_cache/
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd reintroduce the /.mypy_cache/ since we're actively using mypy in our CI

Comment on lines -18 to -22
# Coverage artifacts
/.coverage
/htmlcov/
/docs/build/
/.hypothesis/
Copy link
Contributor

Choose a reason for hiding this comment

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

Why were these removed? We're using coverage and the sphinx documentation files are in /docs/build/.

Comment on lines -24 to -25
# customized config files
/test/test_config.ini
Copy link
Contributor

Choose a reason for hiding this comment

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

I would keep this

# customized config files
/test/test_config.ini
# Schema files needed for testing
/test/adapter/schemas
Copy link
Contributor

Choose a reason for hiding this comment

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

These are also actively used in the CI, so it makes sense to keep them

@s-heppner
Copy link
Contributor

The issues have been solved in #313, therefore this PR is not needed anymore.

@s-heppner s-heppner closed this Oct 14, 2024
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