-
Notifications
You must be signed in to change notification settings - Fork 29
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
Conversation
- Remove reference to aas-compliance-check from pyproject.toml - Add newline at end of pyproject.toml - Remove entry point for aas-compliance-check from setup.py
There was a problem hiding this 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
Clean up .gitignore to include only relevant build artifacts
Added a more detailed comment for the setuptools_scm configuration, explaining its purpose and behavior.
# Temporary files | ||
*.tmp | ||
*.bak | ||
*.swp |
There was a problem hiding this comment.
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__/ |
There was a problem hiding this comment.
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/ |
There was a problem hiding this comment.
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
# Coverage artifacts | ||
/.coverage | ||
/htmlcov/ | ||
/docs/build/ | ||
/.hypothesis/ |
There was a problem hiding this comment.
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/
.
# customized config files | ||
/test/test_config.ini |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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
The issues have been solved in #313, therefore this PR is not needed anymore. |
This PR updates pyproject.toml to use setuptools_scm for automated versioning:
dynamic = ["version"]
to[project]
sectionThis change allows automatic version management based on Git tags, addressing issue #303.
To use:
git tag v1.0.1
git push --tags
Versions between releases will be like
1.0.1.dev4+g12345
.Please review and suggest any needed changes.