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

Auto Update Feluda and Operator package version numbers #440

Open
dennyabrain opened this issue Nov 17, 2024 · 0 comments
Open

Auto Update Feluda and Operator package version numbers #440

dennyabrain opened this issue Nov 17, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request level:feature priority:high python Pull requests that update Python code

Comments

@dennyabrain
Copy link
Contributor

dennyabrain commented Nov 17, 2024

There seems to be some confusion on the requirements of what auto update means, so I thought i'll clarify the intent and give some examples.

With the new refactor we have a lot of packages to manage. The main one being the feluda package and then for every operator there would be one package. Soon we will have > 10 operators and they all have individual version numbers.

What we should have is that anytime a new release is created, the appropriate .toml files should be updated with new version numbers. The versioning uses semantic versioning which follow the syntax MAJOR.MINOR.PATCH

One proposed way to identify which number to increment is to use conventional commits. All commit messages in feluda follow convetions from conventional commits. we use the prefixes like "feat", "chore", "docs", "fix" to denote the type of change. Those usually map to the kind of increment to do on version number. For example feat is usually a new feature and can be a MINOR version whereas fix would be a PATCH. One of the convention is to add the scope of your commit in parentheses, in which case your prefix becomes "feat(image_vec_rep_resnet)", this indicates that a new feature has been added to the image_vec_rep_resnet operator and hence only its version should be updated.
This is a suggestion, there could be other approaches as well.

As part of this issue, I'd appreciate if first we could collect examples of projects like ours and see how they are managing versions. After comparing multiple approaches, we can pick one.

@aatmanvaidya aatmanvaidya self-assigned this Nov 18, 2024
@aatmanvaidya aatmanvaidya added enhancement New feature or request level:feature python Pull requests that update Python code priority:high labels Nov 18, 2024
@aatmanvaidya aatmanvaidya moved this to In Progress in 2024 Q4 Planner Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request level:feature priority:high python Pull requests that update Python code
Projects
Status: In Progress
Development

No branches or pull requests

2 participants