Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description of the usage of various GitHub actions in Polyphy #96

Merged
merged 1 commit into from
Jun 1, 2024
Merged

Description of the usage of various GitHub actions in Polyphy #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,14 @@ tox -av # to list all the tasks available
```

#### GitHub Actions
GitHub Actions is being used to test on MacOs as well as Linux. It allows for the automation of the building, testing, and deployment pipline.

GitHub Actions used for Polyphy are:

- **`batch_mode.yml`**: Automates testing for the Polyphy project by running `polyphy.py` scripts on Ubuntu, ensuring expected output files are generated.
- **`macos_python.yml`**: Runs tests on MacOS with multiple Python versions, including linting with `flake8` and testing with `pytest`.
- **`python-package.yml`**: Builds and tests the Polyphy Python package on Ubuntu 22.04 across various Python versions, including linting and code coverage reporting.
- **`release_package.yml`**: Publishes the Polyphy package to `PyPI` if a new version is detected, using `Twine` for the upload process.
- **`ubuntu20_python.yml`**: Runs tests on Ubuntu 20.04 with multiple Python versions, including linting, `pytest` for Python files, and `pytest` for Jupyter notebooks.

#### Codecov
A service that generates a visual report of how much code has been tested. All configuration settings can be found in the codecov.yml file.
Expand Down
Loading