preparing pypi publishing #5

Merged
chacha merged 1 commits from dev into master 2023-09-30 00:29:50 +02:00
4 changed files with 36 additions and 13 deletions

2
Jenkinsfile vendored
View File

@@ -27,7 +27,7 @@ def _bDraft = false
// release content / changelog management
def _bAutoChangelog = true //Not supported yet
def _ReleaseContent_Title = "# _CI/CD Automatic Release_"
def bPushMasterOnPypi = false
def bPushMasterOnPypi = true
// full rebuild toogle
def _bFullRebuilt = true
def _MkDocsWebURL = "dabauto--mkdocs-web.dmz.chacha.home/mkdocs-web/"

View File

@@ -8,4 +8,6 @@
![](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/).

View File

@@ -1,16 +1,36 @@
# Usage
## Pulvinar dolor
Donec dapibus est fermentum justo volutpat condimentum. Integer quis nunc neque. Donec dictum vehicula justo, in facilisis ex tincidunt in.
Vivamus sollicitudin sem dui, id mollis orci facilisis ut. Proin sed pulvinar dolor. Donec volutpat commodo urna imperdiet pulvinar. Fusce eget aliquam risus.
Vivamus viverra luctus ex, in finibus mi. Nullam elementum dapibus mollis. Ut suscipit volutpat ex, quis feugiat lacus consectetur eu.
`
> <python_bin> -m chacha_cicd_helper -h
> usage: chacha-cicd-helper [-pp PROJECTPATH] [-tc] [-ut] [-cc] [-qc] [-dg] [-pdf] [-cpc] [-h]
## Condimentum faucibus
Quisque auctor egestas sem, luctus suscipit ex maximus vitae. Duis facilisis augue et condimentum faucibus.
Donec cursus, enim a sagittis egestas, lectus lorem eleifend libero, at tincidunt leo magna at libero.
Nunc eros velit, suscipit luctus tempor vel, finibus et est. Curabitur efficitur pretium pulvinar.
Donec urna lectus, vulputate quis turpis sed, placerat congue urna. Phasellus aliquet fermentum quam, non auctor elit porta nec. Morbi eu ligula at nisl ultricies condimentum vitae id ante.
A bundle of cicd helper tools
## Aliquam lacinia
In volutpat lorem ex, et fringilla nibh faucibus quis. Mauris et arcu elementum, auctor dui vitae, egestas arcu. Duis sit amet aliquam quam.
Phasellus a odio turpis. Etiam tristique mi eu enim varius, eget facilisis est vestibulum. Aliquam lacinia nec purus sed luctus. Cras at laoreet erat.
optional arguments:
-pp PROJECTPATH, --projectpath PROJECTPATH
path of the python project to process
-tc, --typecheck enable static typing check
-ut, --unittest enable unit-test
-cc, --coveragecheck enable unit-test coverage check (requires unit-test)
-qc, --qualitycheck enable code quality check
-dg, --docgen enable documentation generation using MkDoc
-pdf, --docgenpdf enable pdf documentation export (requires doc-gen)
-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.
Note: This helper aim to be used by pychachadummyproject template instantiation.

View File

@@ -34,6 +34,7 @@ class cl_types_check(cl_helper_withresults_base):
"--explicit-package-bases",
# "--strict-equality",
# "--check-untyped-defs",
"--enable-incomplete-feature=Unpack",
# reports generation
"--cobertura-xml-report",
str(cls.get_result_dir()),