Skip to content

feat: Added automatic version control based in tags #83

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

alejandrogranizo
Copy link
Contributor

WHAT

This PR introduces changes in the release workflow to update the version of the package to be published to Pypi automatically. The version is taken from the last active tag in GitHub repo. Tags are expected to follow the semantic versioning guidelines (e.g. v0.0.1 is a valid tag). It also updates the version field included in init,py files when it is declared.

WHY

This changes unify the versioning of the package into a single mechanism (as decided in open meetings it is via GitHub tags) and takes care that every automatic deploy is correctly versioned.

FURTHER NOTES

⚠️ IMPORTANT NOTES ⚠️

  • Previous to 25.09 release, which is the first stable version and expected to be tagged v1.0.0, all tags MUST be set with 0 as major version (v0.0.1 to v0.X.X)
  • This workflow does only update the version in the generated package in the GitHub workflow, NOT in the code that is still in the repository. Code published to
  • When checking the release.yml logs from the workflow execution (appears as PyPi Publish), in the building step, poetry logs show buliding version 0.0.0, when in reality the version is correctly built. To check that it is working right, next step's logs show how it uploads the artifact and provides a download link, in which the version and files can be checked to see it is working.

Closes #117

@CDiezRodriguez CDiezRodriguez self-requested a review April 11, 2025 10:43
Copy link
Contributor

@CDiezRodriguez CDiezRodriguez left a comment

Choose a reason for hiding this comment

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

Could you update the DEPENDENCIES_TRACTUS-X_SDK text with the text located here?

@alejandrogranizo alejandrogranizo force-pushed the test_versioning branch 3 times, most recently from 98f03f9 to cb780d0 Compare April 11, 2025 10:59
@alejandrogranizo alejandrogranizo force-pushed the test_versioning branch 2 times, most recently from eea73f9 to f7f16e8 Compare April 11, 2025 11:15
@CDiezRodriguez CDiezRodriguez requested a review from gomezbc April 11, 2025 12:23
Copy link
Contributor

@CDiezRodriguez CDiezRodriguez left a comment

Choose a reason for hiding this comment

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

Could you sync it with the main branch?

@@ -39,6 +39,7 @@ pypi/pypi/-/pytest/8.1.1, MIT, approved, #19365
pypi/pypi/-/python-dotenv/1.0.1, BSD-2-Clause AND BSD-3-Clause, approved, clearlydefined
pypi/pypi/-/python-keycloak/4.0.1, MIT, approved, clearlydefined
pypi/pypi/-/python-multipart/0.0.20, Apache-2.0, approved, clearlydefined
pypi/pypi/-/requests-mock/1.12.1, Apache-2.0, approved, clearlydefined
Copy link
Contributor

Choose a reason for hiding this comment

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

This dependency is already in the main branch.

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.

Have the SDK version in one file
3 participants