Skip to content

Commit

Permalink
Additional information
Browse files Browse the repository at this point in the history
-  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
DrYak committed May 28, 2024
1 parent 86136a9 commit 9fac09f
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
8 changes: 8 additions & 0 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
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.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,11 @@ general:
Also see [snakemake's documentation](https://snakemake.readthedocs.io/en/stable/executing/cli.html) to learn more about the command-line options available when executing the workflow.
Tutorials introducing usage of V-pipe are available in the [docs/](docs/README.md) subdirectory.
### Tutorials
Tutorials for your first steps with V-pipe for different scenarios are available in the [docs/](docs/README.md) subdirectory.
Tutorials for your first steps with V-pipe for different scenarios are available in the [docs/](docs/README.md) subdirectory.
### Using quick install script
Expand Down
10 changes: 8 additions & 2 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
This tests in this directory are not run routinely.
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 at https://github.com/cbg-ethz/V-pipe/tree/master/.github/workflows.
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.

0 comments on commit 9fac09f

Please sign in to comment.