docs: skip teapot steps with metadata
All checks were successful
build-image / create-empty-commit (push) Successful in 5s
checks / build (push) Successful in 1m14s

This commit is contained in:
张泊明518370910136 2024-09-26 03:38:22 -04:00
parent 863e562743
commit 6af7be6cb1
GPG Key ID: D47306D7062CDA9D

View File

@ -136,6 +136,8 @@ Does not parse the output of `ExecutorResult`. It just output what is set inside
In `joint-teapot`, it will take the content before `-` of the comment of the first stage with name `metadata` as the exercise name and record in the scoreboard. (e.g. If the comment is `p2-s2-0xdeadbeef`, then the exercise name is `p2`.)
The comment in `metadata` can also be used to skip teapot commands. With `skip-teapot` in the comment, teapot will not run. And with `skip-scoreboard`, `skip-failed-table`, and `skip-result-issue`, only the corresponding step will be skipped, while the others will be executed. (e.g. If the comment is `p2-s2-0xdeadbeef-skip-scoreboard-skip-result-issue`, then only failed table step in teapot will run.)
### Healthcheck
Parser for the `healthcheck` binary mentioned before.