Skip to content

Commit

Permalink
fixing comments in quicktest-runner workflow file
Browse files Browse the repository at this point in the history
  • Loading branch information
taha-abdullah committed Aug 14, 2024
1 parent 91a2e28 commit 72b0075
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions .github/workflows/quicktest_runner.yaml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
name: quicktest-docker
name: quicktest-runner

"""
File: quicktest_runner.yaml
Author: Taha Abdullah
Created on: 2023-07-10
Functionality: This workflow runs FastSurfer on MRI data and runs pytest to check if the results are acceptable. It also checks if the FastSurfer environment and output already exist, and if not, it creates them.
Usage: This workflow is triggered on a pull request to the dev and main branch. It can also be triggered manually with workflow-dispatch.
Expected/Used Environment Variables:
- MAMBAPATH: Path to the micromamba binary.
- MAMBAROOT: Root path for micromamba.
- RUNNER_FS_OUTPUT: Path to the directory where FastSurfer output is stored.
- RUNNER_FS_MRI_DATA: Path to the directory where MRI data is stored.
- FREESURFER_HOME: Path to the freesurfer directory.
- FS_LICENSE: Path to the FreeSurfer license file.
"""
# File: quicktest_runner.yaml
# Author: Taha Abdullah
# Created on: 2023-07-10
# Functionality: This workflow runs FastSurfer on MRI data and runs pytest to check if the results are acceptable. It
# also checks if the FastSurfer environment and output already exist, and if not, it creates them.
# Usage: This workflow is triggered on a pull request to the dev and main branch. It can also be triggered manually
# with workflow-dispatch.
# Expected/Used Environment Variables:
# - MAMBAPATH: Path to the micromamba binary.
# - MAMBAROOT: Root path for micromamba.
# - RUNNER_FS_OUTPUT: Path to the directory where FastSurfer output is stored.
# - RUNNER_FS_MRI_DATA: Path to the directory where MRI data is stored.
# - FREESURFER_HOME: Path to the freesurfer directory.
# - FS_LICENSE: Path to the FreeSurfer license file.

on:
pull_request:
Expand Down

0 comments on commit 72b0075

Please sign in to comment.