Skip to content

Commit 6294b44

Browse files
committed
Conformance tests should be their own header in input schema gen readme
Also move part headers to secondary header and added toc
1 parent fc49e54 commit 6294b44

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

cwl_utils/templates/WorkflowInputJsonSchemaTemplate.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,29 @@
11
# Generating the Workflow Input JSON Schema Template
22

3-
# Part 1 - Clone the CWL-TS-Auto directory
3+
<!-- TOC -->
4+
* [Generating the Workflow Input JSON Schema Template](#generating-the-workflow-input-json-schema-template)
5+
* [Part 1 - Clone the CWL-TS-Auto directory](#part-1---clone-the-cwl-ts-auto-directory)
6+
* [Part 2 - Install the typescript-json-schema package](#part-2---install-the-typescript-json-schema-package)
7+
* [Part 3 - Generate the Workflow Input JSON Schema Template](#part-3---generate-the-workflow-input-json-schema-template)
8+
* [Part 4 - Refine the template with the following python script](#part-4---refine-the-template-with-the-following-python-script)
9+
* [Part 5 - Run schema generation against all tests in the cwl v1.2 directory](#part-5---run-schema-generation-against-all-tests-in-the-cwl-v12-directory)
10+
<!-- TOC -->
11+
12+
## Part 1 - Clone the CWL-TS-Auto directory
413

514
```
615
git clone https://github.com/common-workflow-lab/cwl-ts-auto
716
817
cd cwl-ts-auto
918
```
1019

11-
# Part 2 - Install the typescript-json-schema package
20+
## Part 2 - Install the typescript-json-schema package
1221

1322
```
1423
npm install typescript-json-schema@^0.62.0
1524
```
1625

17-
# Part 3 - Generate the Workflow Input JSON Schema Template
26+
## Part 3 - Generate the Workflow Input JSON Schema Template
1827

1928
```bash
2029
npx typescript-json-schema \
@@ -24,7 +33,7 @@ npx typescript-json-schema \
2433
WorkflowInputParameter > workflow_input_json_schema_template.primary.json
2534
```
2635

27-
# Part 4 - Refine the template with the following python script
36+
## Part 4 - Refine the template with the following python script
2837

2938
<details>
3039

@@ -1138,7 +1147,7 @@ python3 refine_workflow_input_json_schema_template.py \
11381147
```
11391148

11401149

1141-
### Run schema generation against all tests in the cwl v1.2 directory
1150+
## Part 5 - Run schema generation against all tests in the cwl v1.2 directory
11421151

11431152
> Note there is a set of six urls and inputs that we test the schema generation against
11441153

0 commit comments

Comments
 (0)