Display git-based version in swagger docs #1105
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
naglepuff
approved these changes
Jan 9, 2024
|
Awesome! Thanks for implementing this! (I just noticed this PR) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1092
Previously the
nmdc-serverpackage's version was hardcoded insetup.pyat0.1. With these changes the version is determined automatically usingsetuptools_scm. Usingsetuptools_scmrequires migrating from the legacysetup.py-based build to usingpyproject.toml. Since we weren't really doing anything particularly dynamic insetup.pythat conversion was pretty straightforward. Since the build process now relies on git state, the.gitdirectory is mounted during the Docker build.I also took the opportunity to get rid of
setup.cfgas well. It was only holding configuration that could be moved elsewhere:isortconfig is now inpyproject.toml. Going forward I think it's good practice to put as much tooling configuration as possible inpyproject.toml.flake8was already being configured in bothsetup.cfgandtox.ini, so that's been consolidated intotox.ini. Sadly they sort of refuse to supportpyproject.toml; might be a good motiviation to switch to ruff at some point.mypysays they supportpyproject.tomlbut I found it to be buggy so I've moved that config to a separatemypy.inifile for now.