docs for conformance

Duke-GCB · Nov 20, 2023 · 4e4fb9a · 4e4fb9a
1 parent 42dd7ad
commit 4e4fb9a
Show file tree

Hide file tree

Showing 21 changed files with 503 additions and 0 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,31 @@
+name: docs
+on:
+  push:
+    branches:
+    - conformance-1.2.1
+    paths:
+    # Only rebuild website when docs have changed
+    - 'README.md'
+    - 'docs/**'
+    - 'mkdocs.yml'
+    - .github/**
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install Conda environment from environment.yml
+      uses: mamba-org/provision-with-micromamba@main
+      with:
+        environment-file: docs/environment.yml
+        environment-name: env_docs
+        channels: conda-forge
+        channel-priority: flexible
+
+    - name: Install project
+      run: |
+        /home/runner/micromamba-root/envs/env_docs/bin/python setup.py install
+
+    - run: /home/runner/micromamba-root/envs/env_docs/bin/mkdocs gh-deploy --force
diff --git a/docs/conformance/1.0/conformance.md b/docs/conformance/1.0/conformance.md
@@ -0,0 +1,30 @@
+## Conformance tests for CWL v1.0 for the latest release
+
+### Classes
+
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/workflow.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/command_line_tool.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/expression_tool.json?icon=commonwl)
+
+### Required features
+
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/required.json?icon=commonwl)
+
+### Optional features
+
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/docker.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/env_var.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/initial_work_dir.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/inline_javascript.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/multiple_input.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/resource.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/scatter.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/schema_def.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/shell_command.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/step_input.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/step_input_expression.json?icon=commonwl)
+![test result](https://flat.badgen.net/https/raw.githubusercontent.com/Terradue/calrissian/conformance-1.2.1/conformance/badges/1.0.2/subworkflow.json?icon=commonwl)
+
+### Conformance output
+
+[log](../result-1.0.txt)
diff --git a/docs/conformance/1.0/result-1-0.txt b/docs/conformance/1.0/result-1-0.txt
diff --git a/docs/conformance/badges/1.0.2/command_line_tool.json b/docs/conformance/badges/1.0.2/command_line_tool.json
@@ -0,0 +1 @@
+{"subject": "command_line_tool", "status": "97%", "color": "yellow"}
diff --git a/docs/conformance/badges/1.0.2/docker.json b/docs/conformance/badges/1.0.2/docker.json
@@ -0,0 +1 @@
+{"subject": "docker", "status": "75%", "color": "yellow"}
diff --git a/docs/conformance/badges/1.0.2/env_var.json b/docs/conformance/badges/1.0.2/env_var.json
@@ -0,0 +1 @@
+{"subject": "env_var", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/expression_tool.json b/docs/conformance/badges/1.0.2/expression_tool.json
@@ -0,0 +1 @@
+{"subject": "expression_tool", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/initial_work_dir.json b/docs/conformance/badges/1.0.2/initial_work_dir.json
@@ -0,0 +1 @@
+{"subject": "initial_work_dir", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/inline_javascript.json b/docs/conformance/badges/1.0.2/inline_javascript.json
@@ -0,0 +1 @@
+{"subject": "inline_javascript", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/multiple_input.json b/docs/conformance/badges/1.0.2/multiple_input.json
@@ -0,0 +1 @@
+{"subject": "multiple_input", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/required.json b/docs/conformance/badges/1.0.2/required.json
@@ -0,0 +1 @@
+{"subject": "required", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/resource.json b/docs/conformance/badges/1.0.2/resource.json
@@ -0,0 +1 @@
+{"subject": "resource", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/scatter.json b/docs/conformance/badges/1.0.2/scatter.json
@@ -0,0 +1 @@
+{"subject": "scatter", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/schema_def.json b/docs/conformance/badges/1.0.2/schema_def.json
@@ -0,0 +1 @@
+{"subject": "schema_def", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/shell_command.json b/docs/conformance/badges/1.0.2/shell_command.json
@@ -0,0 +1 @@
+{"subject": "shell_command", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/step_input.json b/docs/conformance/badges/1.0.2/step_input.json
@@ -0,0 +1 @@
+{"subject": "step_input", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/step_input_expression.json b/docs/conformance/badges/1.0.2/step_input_expression.json
@@ -0,0 +1 @@
+{"subject": "step_input_expression", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/subworkflow.json b/docs/conformance/badges/1.0.2/subworkflow.json
@@ -0,0 +1 @@
+{"subject": "subworkflow", "status": "100%", "color": "green"}
diff --git a/docs/conformance/badges/1.0.2/workflow.json b/docs/conformance/badges/1.0.2/workflow.json
@@ -0,0 +1 @@
+{"subject": "workflow", "status": "100%", "color": "green"}
diff --git a/docs/environment.yml b/docs/environment.yml
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,28 @@
+site_name: Calrissian
+site_description: 'CWL runner for Kubernetes'
+# Repository
+
+repo_name: 'Duke-GCB/calrissian'
+repo_url: 'https://github.com/Duke-GCB/calrissian.git'
+edit_uri: 'blob/main/docs/'
+site_url: 'https://Duke-GCB.github.io/calrissian/'
+
+
+theme:
+  name: material
+
+markdown_extensions:
+- admonition
+- pymdownx.highlight
+- pymdownx.superfences
+- attr_list
+
+plugins:
+- search
+#- mkdocs-jupyter
+
+nav:
+- Introduction: 'index.md'
+- Conformance:
+  - 1.0: 'conformance/1.0/conformance.md'
+