-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Makes sure that reviewers who lost their way and ended up stranded in the middle of the testing infrastructures find their way out and into the tutorials.
- Loading branch information
Showing
3 changed files
with
22 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,13 @@ | ||
# Automated test workflows | ||
|
||
This directory stores workflow scripts that are picked up by GitHub Actions to automatically perform test installations of V-pipe on Mac OS and Linux systems and run end-to-end tests by executing tutorials with real example data. | ||
This ensures successful installation and reproducible execution on different systems. | ||
For each update of V-pipe these workflow scripts are automatically executed and report about installation problems or troubles on the test data | ||
|
||
Some of these workflows rely on additional data present in the [`tests/` directory](../../tests). | ||
|
||
## Tutorials | ||
|
||
If you want to test your new V-pipe installation, we strongly encourage you to instead check our tutorials which provide real example data. | ||
|
||
Tutorials for your first steps with V-pipe for different scenarios are available in the [docs/](../../docs/README.md) sub-directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
This tests in this directory are not run routinely. | ||
# Automated test datasets | ||
|
||
The workflow tests that are automatically performed upon each update on GitHub can be found at https://github.com/cbg-ethz/V-pipe/tree/master/.github/workflows. | ||
This directory contains small test datasets which are used for the automated testing of V-pipe as part of the development process. | ||
|
||
The workflow tests that are automatically performed upon each update on GitHub can be found in the [`.github/workflows` directory](../.github/workflows). | ||
|
||
## Tutorials | ||
|
||
If you want to test your new V-pipe installation, we strongly encourage you to instead check our tutorials which provide real example data. | ||
|
||
Tutorials for your first steps with V-pipe for different scenarios are available in the [docs/](../docs/README.md) subdirectory. |