Documentations about the feature RemoteRule and everything concerning the gating.yaml file and how to add some extra policies. Here also some information about how to tolerate invalid gating.yaml file.
This sentence seems redundant.
:file:`gating.yaml`
It must be also valid policy file.
Don't you think if I remove it, it's not really clear how to "start using" the RemoteRule? If you only put a gating.yaml file in the repo without the RemoteRule among the other policies, Greenwave will never check for the gating.yaml file.
I'm willing to change the sentence of course, but I think we should mention something...
rebased onto 4db4ae0d86df4cad27e545e5d51665287f30980b
Rebased and fixed the two other comments.
rebased onto a5b463a61d302346eb84848f90733e929e36a37f
To me it seems that the previous sentence covers this.
I dunno, being redundant is fine in docs from my perspective. Say the same thing two different ways and you will be more sure that the reader understands.
Ah, hang on... this new section still seems to be aimed at admins of the Greenwave instance, not at packagers, right?
At first I thought this was going to show me an example of a gating.yaml, but it's not! It's showing an example of a policy that I (as an admin) can create to make Greenwave obey packager's gating.yaml files.
So all of this extra info is good... but it is not what we need for #222.
I am :+1: to merge this because it's useful info, but it is not actually fixing #222 at all.
but we don't have anything targetted at package maintainers who want to write a package-specific policy for their package.
I think we need a separate doc, let's call it package-specific-policies.rst, which goes like this:
Greenwave can load and enforce package-specific policies from dist-git, in addition to the global policies in Greenwave's configuration.
For Greenwave administrators, see :ref:... for details about how to turn on this feature.
...
If you are a package maintainer, you can write a package-specific policy by creating a specially named :file:gating.yaml file in the root of your package's dist-git repository. When Greenwave is making a decision about your package, it will apply your package-specific rules in addition to any rules in the global Greenwave policies.
gating.yaml
Here is an example :file:gating.yaml file::
The structure of the file is the same as the policies in Greenwave's configuration, with the following differences:
Refer to :ref:... for details about each of the keys in the YAML file.
Oh ok. Sounds clear. So I'll merge this one at this point and write something else only for the packagers.
Commit 03ac0598 fixes this pull-request
Pull-Request has been merged by gnaponie
Documentations about the feature RemoteRule and everything concerning
the gating.yaml file and how to add some extra policies. Here also
some information about how to tolerate invalid gating.yaml file.