pyTooling/Actions
1
0
Fork 0
mirror of https://github.com/pyTooling/Actions.git synced 2026-02-12 02:56:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated README according to latest changes.

Browse Source
This commit is contained in:
Patrick Lehmann
2021-12-24 21:05:04 +01:00
parent 1fbeef36d6
commit 78b225195f
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -95,13 +95,16 @@ As shown in the screenshot above, the expected order is:
- Global: - Global:
- [Parameters](.github/workflows/Parameters.yml): a workaround for the limitations to handle global variables in - [Parameters](.github/workflows/Parameters.yml): a workaround for the limitations to handle global variables in
GitHub Actions workflows (see [actions/runner#480](https://github.com/actions/runner/issues/480)). GitHub Actions workflows (see [actions/runner#480](https://github.com/actions/runner/issues/480)).
It generates outputs with artifact names and job matrices to be used in other jobs. It generates outputs with artifact names and job matrices to be used in later running jobs.
- Code testing/analysis: - Code testing/analysis:
- [UnitTesting](.github/workflows/UnitTesting.yml): run unit test with `pytest` using multiple versions of Python, and - [UnitTesting](.github/workflows/UnitTesting.yml): run unit test with `pytest` using multiple versions of Python, and
optionally upload results as XML reports. optionally upload results as XML reports. Configuration options to `pytest` should be given via section
- [CoverageCollection](.github/workflows/CoverageCollection.yml): collect coverage data with `pytest` using a single `[tool.pytest.ini_options]` in a `pyproject.toml` file.
version of Python, generate HTML and Cobertura (XML) reports, upload the HTML report as an artifact, and upload the - [CoverageCollection](.github/workflows/CoverageCollection.yml): collect code coverage data (incl. branch coverage)
results to Codecov and Codacy. with `pytest`/`pytest-cov`/`coverage.py` using a single version of Python (latest). It generates HTML and Cobertura
(XML)reports, upload the HTML report as an artifact, and upload the test results to Codecov and Codacy. Configuration
options to `pytest` and `coverage.py` should be given via section `[tool.pytest.ini_options]` and `[tool.coverage.*]`
in a `pyproject.toml` file.
- [StaticTypeCheck](.github/workflows/StaticTypeCheck.yml): collect static type check result with `mypy`, and - [StaticTypeCheck](.github/workflows/StaticTypeCheck.yml): collect static type check result with `mypy`, and
optionally upload results as an HTML report. optionally upload results as an HTML report.
Example `commands`: Example `commands`:
@@ -128,7 +131,7 @@ As shown in the screenshot above, the expected order is:
mypy --html-report ../htmlmypy -p ToolName mypy --html-report ../htmlmypy -p ToolName
``` ```
- [VerifyDocs](.github/workflows/VerifyDocs.yml): extract code examples from the README and test. - [VerifyDocs](.github/workflows/VerifyDocs.yml): extract code examples from the README and test these code snippets.
- Packaging and releasing: - Packaging and releasing:
- [Release](.github/workflows/Release.yml): publish GitHub Release. - [Release](.github/workflows/Release.yml): publish GitHub Release.
- [Package](.github/workflows/Package.yml): generate source and wheel packages, and upload them as an artifact. - [Package](.github/workflows/Package.yml): generate source and wheel packages, and upload them as an artifact.