Skip to content

Commit

Permalink
update workflows readme (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
fsoubelet authored Sep 22, 2022
1 parent bfd0593 commit ae2ea8b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ It runs on `ubuntu-latest` and `Python 3.9`.
### Testing Suite

Tests are ensured in the `tests` workflow, which triggers on all pushes.
Tests run on a matrix of all supported operating systems for all supported Python versions (currently `3.7+`).
Tests run on a matrix of all GitHub Actions supported operating systems for all supported Python versions (currently `3.8+`).

### Test Coverage

Test coverage is calculated in the `coverage` wokflow, which triggers on pushes to `master` and any push to a `pull request`.
It runs on `ubuntu-latest` and `Python 3.9`, and reports the coverage results of the test suite to `Codecov`.


### Regular Testing

A `cron` workflow triggers every Saturday at 12:00 (UTC time) and runs the full testing suite, on all available operating systems and supported Python versions.
It also runs on `Python 3.x` so that newly released Python versions that would break tests are automatically detected.
A `cron` workflow triggers every Saturday at 12:00 (UTC time) and runs the full testing suite, on all GitHub Actions supported operating systems for all supported Python versions (currently `3.8+`).
It also runs on `Python 3.x` so that newly released Python versions that would break tests are automatically detected and reported.

### Publishing

Publishing to `PyPI` is done through the `publish` workflow, which triggers anytime a `release` is made of the Github repository.
It builds a `tar` and a `wheel` and pushes to `PyPI` if the builds are successful.
Publishing to `PyPI` is done through the `publish` workflow, which triggers anytime a `release` is made of the GitHub repository and runs on `ubuntu-latest` and `Python 3.9`.
It builds a source distribution (`tar.gz`) and a `wheel` of the package, and pushes to `PyPI` if the builds are successful.
No matrix is needed for this build as `pyhdtoolkit` is a pure python package and generates `*-py3-none-any.whl` wheels.

0 comments on commit ae2ea8b

Please sign in to comment.