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

Ease the process of code versioning #3035

Open
untereiner opened this issue Mar 11, 2024 · 4 comments
Open

Ease the process of code versioning #3035

untereiner opened this issue Mar 11, 2024 · 4 comments
Assignees
Labels
type: feature New feature or request type: new A new issue has been created and requires attention

Comments

@untereiner
Copy link
Contributor

untereiner commented Mar 11, 2024

What is the requested feature?
Automate the code versioning process to have effective versioning of the code and maybe releases.

Is your request related to a specific problem?
I would like an easy, human readable, comparable way to discriminate versions of the public API (i.e. represented as xsd files #2971). Not sure a commit hash is the right way.

Describe the solution you'd like
I was thinking to something close to semver.

But, doing it manually is painful and time consuming.
So what about using a github-action like this one: https://github.com/ietf-tools/semver-action.
It will flow seamlessly for those using commit prefixes.
For the others, we could simply avoid the patch part and adopt a simple algorithm like this one:

If the PR needs a rebaseline (xsd change)  then bump major part
else bump minor part.

This action will make the next version available as a variable in the pipeline.
It should then be easy to patch the CMakeLists, a header file, xsd schemas, or whatever...

What to you think ?

Describe alternatives you've considered
n.a.

Additional context
n.a.

Related: #3043

@untereiner untereiner added type: feature New feature or request type: new A new issue has been created and requires attention labels Mar 11, 2024
@TotoGaz TotoGaz removed their assignment Mar 11, 2024
@MelReyCG
Copy link
Contributor

MelReyCG commented Mar 12, 2024

So, if I iterate on my branch, the version number will not change.
To improve this version number, I think we should add a build part (As semver seems to allow it).

@MelReyCG
Copy link
Contributor

We should also keep this issue in mind.

@TotoGaz
Copy link
Contributor

TotoGaz commented Mar 18, 2024

@castelletto1 What do we want to do regarding this?

@untereiner
Copy link
Contributor Author

if #3043 is merged, it will be easy to add versions by following the semantic conventions of the merged commit messsages.
The semver-action will roll-out the commit messages between the tip and the previous release and analyse the prefixes to compute a new version number

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature New feature or request type: new A new issue has been created and requires attention
Projects
None yet
Development

No branches or pull requests

5 participants