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

Enforce versioning guideline by CI checks #13

Closed
leogr opened this issue Jan 18, 2023 · 6 comments
Closed

Enforce versioning guideline by CI checks #13

leogr opened this issue Jan 18, 2023 · 6 comments
Labels
kind/feature New feature or request lifecycle/stale

Comments

@leogr
Copy link
Member

leogr commented Jan 18, 2023

Motivation

Currently, the versioning guidelines need to be manually checked and applied by maintainers, which is an error-prone process.

Also, see my comment here.

cc @falcosecurity/falco-maintainers

Feature

Enforce versioning guidelines using the CI.

One possible solution would be to automatically add a label indicating the type of change (major, minor, patch) to incoming PRs. In this way, it will be immediately clear to the release manager which version number must be bumped when git tagging.

Alternatives

Additional context

Off-topic
A similar approach could be used in libs too since we have a similar problem with internal version numbers (ie. DRIVER_VERSION and SCHEMA_VERSION)
cc @falcosecurity/libs-maintainers

@jasondellaluce
Copy link
Contributor

The label-based approach seems interesting. Another way could be to introduce a custom release note syntax (like we use to do for Falco).

The approach that I would prefer the most would be for Falco to "dump" (in a machine-readable format) all the definitions loaded in a given rules file and being able to apply all/most of the versioning guidelines automatically. This also matches the request of issues such as falcosecurity/falco#1814, which still want Falco to dump its rules internal knowledge for ease of debugging and development. Just an idea, maybe not attainable, but would be cool.

@mstemm
Copy link
Contributor

mstemm commented Jan 18, 2023

How will this version relate to the required_engine_version? I would think it would be appealing to have the major number be equal to the required_engine_version but that doesn't quite line up with the versioning guidelines doc.

I guess one way they would be related is that any time the required_engine_version is changed, the major number also has to be incremented. But the versioning guidelines doc talks about changes in the minor number related to required engine version changes, so that isn't consistent.

Also, what will happen when loading multiple rules files, like default and local files? There isn't any attempt to relate those version numbers, is there?

@leogr
Copy link
Member Author

leogr commented Mar 19, 2023

/kind feature
/milestone falco-rules-0.2

@poiana poiana added the kind/feature New feature or request label Mar 19, 2023
@leogr leogr added this to the falco-rules-0.2 milestone Mar 19, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in Falco Roadmap Mar 19, 2023
@poiana
Copy link

poiana commented Jun 17, 2023

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

@jasondellaluce
Copy link
Contributor

This is now accomplished.

/close

@poiana
Copy link

poiana commented Jun 19, 2023

@jasondellaluce: Closing this issue.

In response to this:

This is now accomplished.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@poiana poiana closed this as completed Jun 19, 2023
@github-project-automation github-project-automation bot moved this from Todo to Done in Falco Roadmap Jun 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature New feature or request lifecycle/stale
Projects
Archived in project
Development

No branches or pull requests

4 participants