From be511c366d7bba8fa40510f531da7fc33d43ff2c Mon Sep 17 00:00:00 2001 From: cclecle Date: Sat, 30 Sep 2023 00:24:19 +0100 Subject: [PATCH 1/2] fix (readme): doc link to master chore (readme): repository to fixed (real) one --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5fb7476..f5dc407 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=status&status=active&color=seagreen) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=doc&status=MkDocs&color=blue) -![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=jenkins-unittest&job={{repository}}-{{branch}}) -![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=coverage) -![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=maintainability) -![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=quality) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=jenkins-unittest&job=chacha_cicd_helper-{{branch}}) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job=chacha_cicd_helper-{{branch}}&build=0&config=coverage) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job=chacha_cicd_helper-{{branch}}&build=0&config=maintainability) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job=chacha_cicd_helper-{{branch}}&build=0&config=quality) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=licence&status=CC%20BY-NC-SA%204.0&color=teal) ![](docs-static/Library.jpg) A set of tool to help continuous integration. -Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/{{repository}}/{{branch}}/latest/). +Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/chacha_cicd_helper/master/latest/). -- 2.47.3 From 4608fe637effade244381a580b515ebc3f1c421b Mon Sep 17 00:00:00 2001 From: cclecle Date: Sat, 30 Sep 2023 00:31:17 +0100 Subject: [PATCH 2/2] update usage --- docs-static/usage.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/docs-static/usage.md b/docs-static/usage.md index 7c40796..9751a99 100644 --- a/docs-static/usage.md +++ b/docs-static/usage.md @@ -1,6 +1,6 @@ # Usage -` +``` > -m chacha_cicd_helper -h > usage: chacha-cicd-helper [-pp PROJECTPATH] [-tc] [-ut] [-cc] [-qc] [-dg] [-pdf] [-cpc] [-h] @@ -18,19 +18,23 @@ optional arguments: -cpc, --complexitycheck enable complexity check -h, --help show this help message and exit - ` + ``` Calling those commands will create a directory called `helpers-results` in `` (or in the current directory). This directory will contain some of the following subdirectory, depending on what enabled: -* cl_complexity_check -> code complexity measurement report -* cl_doc_gen -> mkdocs documentation output (html + pdf) -* cl_quality_check -> quality check reports -* cl_types_check -> type check reports -* cl_unit_test -> unit test reports -* cl_unit_test_coverage -> unit test coverage reports -* cl_unit_test_full -> full unitest report (merged) -Note: needs a docs-static directory in the target project root. Then one can put any .md file inside. +| Directory | Content | +|-----------------------|---------------------------------------------| +| cl_complexity_check | code complexity measurement report | +| cl_doc_gen | mkdocs documentation output (html + pdf) | +| cl_quality_check | quality check reports | +| cl_quality_check | quality check reports | +| cl_types_check | type check reports | +| cl_unit_test | unit test reports | +| cl_unit_test_coverage | unit test coverage reports | +| cl_unit_test_full | full unitest report (merged) | -Note: This helper aim to be used by pychachadummyproject template instantiation. \ No newline at end of file +> Note: needs a docs-static directory in the target project root. Then one can put any .md file inside. + +> Note: This helper aim to be used by pychachadummyproject template instantiation. \ No newline at end of file -- 2.47.3