chacha/chacha_cicd_helper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 49 Wiki Activity

dev #6

Merged
chacha merged 2 commits from dev into master 2023-09-30 01:34:01 +02:00
Conversation 0 Commits 2 Files Changed 2 +20 -16
2 changed files with 20 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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/).

26
docs-static/usage.md
View File

@@ -1,6 +1,6 @@
# Usage
`
```
> <python_bin> -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 `<PROJECTPATH>` (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: <docgen> 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.
> Note: <docgen> 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.