docs(action): say that a clean run posts no first comment (#121)

Signed-off-by: Bart Waardenburg <bart@waardenburg.dev>

Author: BartWaardenburg

action.yml

@@ -56,7 +56,7 @@ inputs:
     required: false
     default: ''
   comment:
-    description: 'Post or update one sticky pull request comment with the gates and the findings. Needs `permissions: pull-requests: write`. A pull request from a fork posts no comment.'
+    description: 'Post or update one sticky pull request comment with the gates and the findings. A clean run posts no first comment. Needs `permissions: pull-requests: write`. A pull request from a fork posts no comment.'
     required: false
     default: 'false'
   comment-key:

action/README.md

@@ -108,7 +108,7 @@ does not fail on them:
 | `auto-changed-since` | `false` | On a pull request, pass the base commit of the pull request as `--changed-since` when `changed-since` is empty. |
 | `baseline` | empty | A baseline file from `--save-baseline`, relative to `working-directory`. The action passes it as `--baseline`. |
 | `save-baseline` | empty | Write the findings of the run to this file (`--save-baseline`). The run then exits 0. |
-| `comment` | `false` | Post one sticky comment on the pull request, or update it. See [Pull request comment](#pull-request-comment). |
+| `comment` | `false` | Post one sticky comment on the pull request, or update it. A clean run posts no first comment. See [Pull request comment](#pull-request-comment). |
 | `comment-key` | empty | The key of the sticky comment. Use letters, digits, `.`, `-` and `_`. When empty, the action uses the command name. Give each call its own key when two calls run the same command. |
 | `artifacts-dir` | empty | The folder for the report files. When empty, the action makes a new folder in `RUNNER_TEMP` for each call. |
 | `github-token` | `github.token` | The token for the code scanning check, the SARIF upload and the pull request comment. |

ci/gitlab-ci.yml

@@ -3,7 +3,8 @@
 # Run the static checks of cargo-fallow on a Rust workspace. The job writes a
 # GitLab code quality report, so the merge request widget shows the findings.
 # With CARGO_FALLOW_COMMENT it also posts one merge request note with the
-# markdown report, and updates that note on the next run.
+# markdown report, and updates that note on the next run. A clean run posts
+# no first note.
 #
 # Usage: add to your .gitlab-ci.yml:
 #
@@ -52,7 +53,8 @@
     # CARGO_FALLOW_AUTO_CHANGED_SINCE is "true".
     CARGO_FALLOW_CHANGED_SINCE: ""
     CARGO_FALLOW_AUTO_CHANGED_SINCE: "true"
-    # "true" posts one merge request note. It needs GITLAB_TOKEN with the api
+    # "true" posts one merge request note, but a clean run posts no first
+    # note. It needs GITLAB_TOKEN with the api
     # scope, as a masked CI/CD variable: CI_JOB_TOKEN cannot write notes.
     CARGO_FALLOW_COMMENT: "false"
     # The marker of the note. Give each job with a note its own key.

docs/gitlab.md

@@ -30,7 +30,7 @@ the vendored scripts.
 | `CARGO_FALLOW_FAIL_ON_ISSUES` | `true` | Fail the job when an enforced gate fails. |
 | `CARGO_FALLOW_CHANGED_SINCE` | empty | A ref for `--changed-since`. |
 | `CARGO_FALLOW_AUTO_CHANGED_SINCE` | `true` | In a merge request pipeline without `CARGO_FALLOW_CHANGED_SINCE`, give `--changed-since` the merge request base. The code quality report always has the full scope: GitLab compares it with the report of the target branch. |
-| `CARGO_FALLOW_COMMENT` | `false` | Post or update one merge request note. |
+| `CARGO_FALLOW_COMMENT` | `false` | Post or update one merge request note. A clean run posts no first note. |
 | `CARGO_FALLOW_COMMENT_KEY` | the command | The marker of the note. Give each job with a note its own key. |
 | `CARGO_FALLOW_INSTALL` | `cargo` | `cargo` runs `cargo install cargo-fallow`. `path` uses the `cargo-fallow` on the `PATH`. |
 | `CARGO_FALLOW_VERSION` | empty | The crates.io version for `cargo`. Empty means the newest version. Pin it: the cache then keeps the binary, and the next job does not build it. |