aboutsummaryrefslogtreecommitdiff
path: root/mingling_ci/help.txt
blob: de006bb16f344a5687d38bccf5353fe8daaec668 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
This program is used to check the code quality of the Mingling project itself.

USAGE: cargo ci <FLAGS> [SUBCOMMAND] <ARGS...>

FLAGS:
  -h, --help                       Print this help page
  -q, --quiet                      Quiet output

COMMANDS:
  UTILS:
   report-collect                  Collect and organize all inspection reports
   report-clean                    Clean up all reports

   git-lock                        Temporarily commit the workspace for CI
   git-unlock                      Restore the workspace after CI

   show-features                   Print the docs.rs feature list of mingling
   show-manifests                  Print all crate paths that need to be checked

  TOOLS:
   example-refresh                 Regenerate example docs module and examples index
   docsify-refresh                 Fix docsify code boxes and regenerate sidebars
   features-refresh                Regenerate the features module

  TASKS:
   markdown-check <PATH>           Verify rust code blocks in one markdown file
   markdown-check-all              Verify rust code blocks in all configured markdown files
   markdown-compare <PATH> <PATH>  Compare the structure of two markdown files/dirs
   markdown-compare-all            Compare all translated docs against the reference
   build-check                     Build all crates
   clippy-check                    Run clippy with -D warnings on all crates
   test-all                        Test all crates
   example-check                   Build examples and run their test.toml cases
   docs-check                      Build mingling docs with -D warnings