Proposal for new commit msg design for engine commits

[Alon Bar-Lev]

----- Original Message -----
> From: "Eyal Edri" <eedri at redhat.com>
> To: "engine-devel" <engine-devel at ovirt.org>
> Cc: "infra" <infra at ovirt.org>
> Sent: Tuesday, July 9, 2013 12:38:51 PM
> Subject: Proposal for new commit msg design for engine commits
> 
> Hi,
> 
> You all probably know and familiar with 'ovirt-engine' git hook for commit
> msg template [1].
> this helps understand the general area of the patch in the project but it
> lacks additional info that might
> be valuable for scaling automatic tests in Jenkins CI.
> 
> Let me explain:
> 
> Infra team is working hard on expanding oVirt CI infrastructure and adding
> more tests in jenkins (per commit/patch).
> Adding important meta-data per patch can significatly improve the ability to
> run specific tests for each patch/commit,
> and not waste valuable resources on Jenkins jobs that are not relevant to the
> code in the patch.
> 
> So the idea is to add/expand current metadata per patch, in the form of:
> (either)
>  1. expanding current header template to include more data like 'network' ,
>  'setup', 'tools', 'virt'

Please do not expand header, it is too short anyway.

>  2. adding a new label with relevant tags for the patch, called e.g
>  'METADATA: network, rest, virt'

Having:

CI-Tests: xxx
CI-Tests: yyy
CI-Tests: zzz

Is much better.

However, I don't think that it is the responsibility of the committer.

I suggested some time ago to have metadata information within each source.

Each source should have metadata of:

1. Maintainer group.
2. Subsystem.
3. Any other relevant.

This way you can act automatically using this information.

Java:
/*
 * $OVIRT_METADATA.COMPONENT=<string>
 */
or:
// $OVIRT_METADATA.COMPONENT=<string>

Shell/python:
# $OVIRT_METADATA.COMPONENT=<string>

Well, you get the idea...

This signature will allow:
a. find . -type f | xargs grep '\$OVIRT_METADATA.COMPONENT=mycomponent'
b. Future automation within gerrit.

Regards,
Alon