💡 Replace Version Check Script with Unit Test

[Nicoretti]

Summary

Currently, the project version is validated through a script as follows:

poetry run version-check `poetry run python -c "from noxconfig import PROJECT_CONFIG; print(PROJECT_CONFIG.version_file)"`

This script is used in this project and others that utilize the same toolbox. We propose replacing this version check script with a dedicated unit test to validate the correctness of the version.

Proposal

1. Unit Test for Version Validation: Create a unit test to check the project's version. This test will ensure the version is correctly configured, making the previous script redundant.

2. Integration with Existing CI/CD: Integrate this unit test into the current CI/CD pipelines. The version-check step can now simply run this unit test.

3. Project Template Change: Update the project-template (cookiecutter template) to include this new unit test:

   • Replace the existing empty smoke test in the template with a dummy test for version validation.
   • If this test initially fails, it will guide the developers on what needs to be implemented or configured, making the process clearer.

By implementing this change, we can improve the maintainability and clarity of version checks across different projects.