plugins icon indicating copy to clipboard operation
plugins copied to clipboard

commit and release note naming conventions

Open jasondellaluce opened this issue 2 years ago • 19 comments

What to document

We have no definite naming conventions for either commits or release notes (I don't think we have release notes at all).

In Falco, we have a naming convention for release notes touching rulesets (see: https://github.com/falcosecurity/.github/blob/main/CONTRIBUTING.md#rule-type), but although this repository is the official place for all our plugin rulesets, we haven't something like this here.

At the same time, our changelog generation tool looks for commit messages following conventional commits specifications. For a given plugin, the changelog will filter commit messages in the form of xxx(plugins): ... or xxx(plugins/<plugin_name>): .... However, there is nothing enforcing this at the CI level, not even with a warning, which ends up potentially missing valuable commits in the changelogs.

*Proposals/Idea

  • Add a CI job checking that:
    • If a file changes in a plugin/<plugin_name> path, then the commit must follow the xxx(plugins/<plugin_name>): ... message pattern
    • If a file changes in more than one plugin/<plugin_name> path, then the commit must follow the xxx(plugins): ... message pattern
  • Check or enforce than the rule(xxx):... commit message format is respected, even in a looser form than what we have in Falco

jasondellaluce avatar Sep 15 '22 08:09 jasondellaluce

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

poiana avatar Dec 14 '22 09:12 poiana

/remove-lifecycle stale

jasondellaluce avatar Dec 15 '22 10:12 jasondellaluce

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

poiana avatar Mar 15 '23 15:03 poiana

Stale issues rot after 30d of inactivity.

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

Rotten issues close after an additional 30d of inactivity.

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

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

/lifecycle rotten

poiana avatar Apr 14 '23 19:04 poiana

/remove-lifecycle stale

Andreagit97 avatar Apr 17 '23 09:04 Andreagit97

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

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

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

poiana avatar May 17 '23 13:05 poiana

@poiana: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

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

Provide feedback via https://github.com/falcosecurity/community. /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 avatar May 17 '23 13:05 poiana

/remove-lifecycle rotten

/reopen

jasondellaluce avatar May 17 '23 16:05 jasondellaluce

@jasondellaluce: Reopened this issue.

In response to this:

/remove-lifecycle rotten

/reopen

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 avatar May 17 '23 16:05 poiana

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

poiana avatar Aug 15 '23 19:08 poiana

/remove-lifecycle stale

Andreagit97 avatar Aug 17 '23 10:08 Andreagit97

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

poiana avatar Nov 15 '23 15:11 poiana

Stale issues rot after 30d of inactivity.

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

Rotten issues close after an additional 30d of inactivity.

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

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

/lifecycle rotten

poiana avatar Dec 15 '23 15:12 poiana

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

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

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

poiana avatar Jan 14 '24 15:01 poiana

@poiana: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

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

Provide feedback via https://github.com/falcosecurity/community. /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 avatar Jan 14 '24 15:01 poiana

/reopen

Andreagit97 avatar Jan 15 '24 09:01 Andreagit97

@Andreagit97: Reopened this issue.

In response to this:

/reopen

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 avatar Jan 15 '24 09:01 poiana

/remove-lifecycle rotten

Andreagit97 avatar Jan 15 '24 09:01 Andreagit97

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

poiana avatar Apr 14 '24 09:04 poiana

Stale issues rot after 30d of inactivity.

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

Rotten issues close after an additional 30d of inactivity.

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

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

/lifecycle rotten

poiana avatar May 14 '24 09:05 poiana

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

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

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

poiana avatar Jun 13 '24 09:06 poiana

@poiana: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

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

Provide feedback via https://github.com/falcosecurity/community. /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 avatar Jun 13 '24 09:06 poiana