lfit / releng-gerrit_to_platform / 28169833359
93%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 8
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 93.214%. Remained the same
28169833359

push

github

askb 
Docs: document gerrit workflow filename matching and naming

The "GitHub Workflow Configuration" section stated only that a triggered
workflow filename "must contain 'gerrit'" and "must contain the search
filter". That is accurate but under-specified, and operators have been
surprised by three behaviours that follow directly from the matching
implementation in ``github.filter_workflows`` / ``filter_path``:

  * The test is ``path.lower().find(filter) >= 0`` -- a case-insensitive
    *substring* match anywhere in the filename, not a prefix or exact
    match.
  * gerrit-to-platform dispatches *every* workflow that matches an
    event, not just one. Any file whose name contains ``gerrit`` and the
    event filter fires; e.g. both ``gerrit-maven-merge.yaml`` and
    ``gerrit-release-merge.yaml`` run on every change-merged event.
  * For comment-added, the search filter is the value mapped to the
    keyword in ``[mapping "comment-added"]``, so the workflow filename
    must contain that mapped filter (not the keyword itself).

Document the recommended ``gerrit-<description>-<event>.yaml`` naming
convention, spell out the substring / all-matching-workflows-fire
semantics, add the resulting cautions (avoid unintended name collisions;
workflows that must not act on every event have to self-gate), and give a
worked comment-added example (``stage-release = stage`` ->
``gerrit-maven-stage.yaml``). Documentation-only change; no code or
behaviour is affected.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Change-Id: Iaa6e05c67
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>

522 of 560 relevant lines covered (93.21%)

0.93 hits per line

Jobs
ID Job ID Ran Files Coverage
1 ubuntu-latest - py3.11 - 28169833359.1 8
93.21
 GitHub Action Run
Source Files on build 28169833359