search

apache / flagon-useralejs

Apache Flagon UserALE is a comprehensive, thin-client behavioral logging tool
https://flagon.apache.org/
Apache License 2.0
26 stars 26 forks source link

CI(semver): Add semantic versioning #447

Open EandrewJones opened 6 months ago

EandrewJones commented 6 months ago

Problem

We currently use semantic versioning but rely on developers to manually update versionings and change logs. This creates lots of room for error.

Solution

Enforce proper semantic versioning and change log updates via commitizen.

EandrewJones commented 6 months ago

Needs more research. We do not necessarily want to manage version updates at the commit level. Is there a way to do this via commitizen or do we need an alternative?

EandrewJones commented 4 months ago

Details

Commitizen is only part of the story here. We also need a means to enforce semantic versioning and implement CI tooling around that. Commitizen is a per-requisite as most automated semver tools expect commit messages to follow the conventional format and then parse them to figure out version bumps.

Then you need a tool like semantic release to benefit from automations around standardized commit messages.

Conversation

@Jyyjy It looks like you can bundle multiple commits into a single bump, it just all depends on how frequently you run your semantic release script and on which branch (i.e. CI challenge). See: https://blog.devgenius.io/automatic-semantic-versioning-and-commit-messages-semantic-release-and-commitizen-72e4eca5f194

We could break this up into multiple issues as conventional commits are a prereq for any automated solution.

Suvendu-UI commented 4 months ago

Sorry to interrupt @EandrewJones but i think you should close this issue my recent PR has solved this issue.

EandrewJones commented 4 months ago

No worries.

If you go look at the PR, you'll notice I created a different issue and edited your PR to link to that. Your PR implements commitizen which provides us with machine-readable commit messages. These are prerequisites to have automated semantic versioning, but commitizen in and of itself does not add provide.

This is a separate issue we still need to solve.

Best

Evan Jones Website: www.ea-jones.com

On Mon, Jul 15, 2024 at 2:07 PM Suvendu-UI @.***> wrote:

Sorry to interrupt @EandrewJones https://github.com/EandrewJones but i think you should close this issue my recent PR has solved this issue.

— Reply to this email directly, view it on GitHub https://github.com/apache/flagon-useralejs/issues/447#issuecomment-2229092580, or unsubscribe https://github.com/notifications/unsubscribe-auth/AJ2T6AIQXQPMOJLHIZYB3F3ZMQFVZAVCNFSM6AAAAABHLHB7P2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMRZGA4TENJYGA . You are receiving this because you were mentioned.Message ID: @.***>