Skip to content

Commit 31ec48a

Browse files
mr-cfmigneault
andauthored
Backport formatting fixes (#210)
* add missing newlines in code samples (#207) * fix over-indented list interpreted as code + typo (#208) Co-authored-by: Francis Charette-Migneault <[email protected]>
1 parent a0f2d38 commit 31ec48a

18 files changed

+291
-63
lines changed

.github/config/spellcheck.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
matrix:
2+
- name: Markdown
3+
aspell:
4+
lang: en
5+
ignore-case: true
6+
dictionary:
7+
encoding: utf-8
8+
wordlists:
9+
- .github/config/wordlist.txt
10+
pipeline:
11+
- pyspelling.filters.markdown:
12+
- pyspelling.filters.html:
13+
comments: true
14+
attributes:
15+
- title
16+
- alt
17+
ignores:
18+
- :matches(code, pre)
19+
sources:
20+
- '**/*.md'
21+
default_encoding: utf-8

.github/config/wordlist.txt

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
acyclic
2+
amstutz
3+
arvados
4+
auditability
5+
avro
6+
backchannel
7+
backrub
8+
basedir
9+
bnf
10+
bogdan
11+
checkpoint
12+
checkpointing
13+
chilton
14+
cisphobia
15+
classname
16+
commandlinetool
17+
commandlinetools
18+
commonwl
19+
complextype
20+
coreutils
21+
ctbrown
22+
curii
23+
curoverse
24+
cwl
25+
cwltest
26+
cwltool
27+
cwlversion
28+
cyclic
29+
dataflow
30+
dev
31+
dockerrequirement
32+
doubleq
33+
dsl
34+
dusenbery
35+
edu
36+
eg
37+
envvarrequirement
38+
expressionlib
39+
expressiontool
40+
expressiontools
41+
filesystem
42+
freedesktop
43+
gavrilovic
44+
ghose
45+
gitter
46+
gmail
47+
hervé
48+
https
49+
ietf
50+
implementer
51+
implementers
52+
implementor
53+
implementors
54+
initialworkdirrequirement
55+
initialworkdirrequirements
56+
inlinejavascriptrequirement
57+
inplaceupdaterequirement
58+
inputparameter
59+
institut
60+
invocab
61+
iri
62+
jmchilton
63+
json
64+
junit
65+
kaushik
66+
ld
67+
lexicographically
68+
linkmerge
69+
lookahead
70+
maccallum
71+
macos
72+
mebibyte
73+
mebibytes
74+
ménager
75+
metaschema
76+
misgendering
77+
mrc
78+
multipleinputfeaturerequirement
79+
multithreaded
80+
namespace
81+
namespaces
82+
nebojsa
83+
nebojša
84+
nekrutenko
85+
networkaccess
86+
neuro
87+
onlinepubs
88+
opengroup
89+
orcid
90+
osx
91+
outputsource
92+
petermac
93+
pickvalue
94+
posix
95+
pre
96+
preprocess
97+
preprocessed
98+
preprocessing
99+
psu
100+
publically
101+
pvanheus
102+
rdf
103+
recurse
104+
repo
105+
reproducibility
106+
resourcerequirement
107+
routable
108+
runtime
109+
sbgenomics
110+
scatterfeaturerequirement
111+
schemadefrequirement
112+
schemaorg
113+
schemas
114+
secondaryfiles
115+
secondaryfilesdsl
116+
shellcommandrequirement
117+
singleq
118+
softwarepackage
119+
softwarerequirement
120+
soiland
121+
stepinputexpressionrequirement
122+
stian
123+
subdirectory
124+
subprocess
125+
subprocesses
126+
subscope
127+
subscoped
128+
subshell
129+
substep
130+
substring
131+
substrings
132+
subtype
133+
subtypes
134+
subworkflow
135+
subworkflowrequirement
136+
superset
137+
svg
138+
tijanic
139+
tijanić
140+
toc
141+
tooltimelimit
142+
transcode
143+
txt
144+
uc
145+
ucdavis
146+
untrusted
147+
uri
148+
utf
149+
vandewege
150+
virtualenv
151+
walkthrough
152+
wdl
153+
whitespace
154+
xdg
155+
yaml

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
push:
99
branches: [ main ]
1010
pull_request:
11-
branches: [ main ]
11+
branches: [ main, 1.2.1_proposed ]
1212

1313
# Allows you to run this workflow manually from the Actions tab
1414
workflow_dispatch:

.github/workflows/cwltool.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: test_with_cwltool
2+
3+
# Controls when the action will run.
4+
on:
5+
# Triggers the workflow on push or pull request events but only for the main branch
6+
push:
7+
branches: [ main ]
8+
pull_request:
9+
branches: [ main, 1.2.1_proposed ]
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
jobs:
15+
test_with_cwltool:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- uses: actions/checkout@v2
20+
21+
- uses: actions/setup-python@v2
22+
with:
23+
python-version: '3.9.x'
24+
25+
- name: Setup prerequirements
26+
run: pip install cwltest cwltool
27+
28+
- name: Run tests against the reference runner
29+
run: ./run_test.sh RUNNER=cwltool "EXTRA=--parallel --relax-path-checks" -j$(nproc)

.github/workflows/spellcheck.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Spellcheck Action
2+
on:
3+
push:
4+
branches: [ main ]
5+
pull_request:
6+
branches: [ main, 1.2.1_proposed ]
7+
workflow_dispatch:
8+
9+
jobs:
10+
build:
11+
# https://github.com/marketplace/actions/github-spellcheck-action
12+
# To run locally, `pip install pyspelling`, followed by
13+
# `pyspelling -c .github/config/spellcheck.yml`.
14+
name: Spellcheck
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@master
18+
- uses: rojopolis/[email protected]
19+
name: Spellcheck
20+
with:
21+
config_path: .github/config/spellcheck.yml

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ except as necessary to protect vulnerable people from intentional abuse.
4343
- Publication of non-harassing private communication.
4444

4545
The CWL Project prioritizes marginalized people’s safety over privileged
46-
people’s comfort. The CWL Leadeship Team will not act on complaints regarding:
46+
people’s comfort. The CWL Leadership Team will not act on complaints regarding:
4747

4848
- ‘Reverse’ -isms, including ‘reverse racism,’ ‘reverse sexism,’ and ‘cisphobia’
4949
- Reasonable communication of boundaries, such as “leave me alone,” “go away,” or

CONFORMANCE_TESTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Likewise, please do not test the `path` for `class: File` and `class: Directory`
184184

185185
To add a new conformance test:
186186
1. Ensure the CWL document you have tests the desired feature or aspect.
187-
2. All `CommandLineTool`s need a software container (via `DockerRequirement`) for better reproducibility, preferrably under `hints`.
187+
2. All `CommandLineTool`s need a software container (via `DockerRequirement`) for better reproducibility, preferably under `hints`.
188188
Please limit your container usage to the following:
189189
- `dockerPull: docker.io/alpine:latest`
190190
- `dockerPull: docker.io/bash:4.4`

CommandLineTool.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ $graph:
143143
doc: |
144144
145145
When listed under `inputBinding` in the input schema, the term
146-
"value" refers to the the corresponding value in the input object. For
146+
"value" refers to the corresponding value in the input object. For
147147
binding objects listed in `CommandLineTool.arguments`, the term "value"
148148
refers to the effective value after evaluating `valueFrom`.
149149
@@ -201,7 +201,7 @@ $graph:
201201
type: string?
202202
doc: |
203203
Join the array elements into a single string with the elements
204-
separated by by `itemSeparator`.
204+
separated by `itemSeparator`.
205205
- name: valueFrom
206206
type:
207207
- "null"
@@ -455,7 +455,7 @@ $graph:
455455
- name: inputBinding
456456
type: CommandLineBinding?
457457
doc: |
458-
Describes how to turns the input parameters of a process into
458+
Describes how to turn the input parameters of a process into
459459
command line arguments.
460460
jsonldPredicate: "cwl:inputBinding"
461461

@@ -859,7 +859,7 @@ $graph:
859859
One or more [IRI](https://en.wikipedia.org/wiki/Internationalized_Resource_Identifier)s
860860
identifying resources for installing or enabling the software named in
861861
the `package` field. Implementations may provide resolvers which map
862-
these software identifer IRIs to some configuration action; or they can
862+
these software identifier IRIs to some configuration action; or they can
863863
use only the name from the `package` field on a best effort basis.
864864
865865
For example, the IRI https://packages.debian.org/bowtie could
@@ -871,19 +871,19 @@ $graph:
871871
software installation or selection mechanism.
872872
Using [RRID](https://www.identifiers.org/rrid/) as an example:
873873
https://identifiers.org/rrid/RRID:SCR_005476
874-
could be fulfilled using the above mentioned Debian or bioconda
875-
package, a local installation managed by [Environement Modules](http://modules.sourceforge.net/),
874+
could be fulfilled using the above-mentioned Debian or bioconda
875+
package, a local installation managed by [Environment Modules](https://modules.sourceforge.net/),
876876
or any other mechanism the platform chooses. IRIs can also be from
877-
identifer sources that are discipline specific yet still system
877+
identifier sources that are discipline specific yet still system
878878
independent. As an example, the equivalent [ELIXIR Tools and Data
879879
Service Registry](https://bio.tools) IRI to the previous RRID example is
880880
https://bio.tools/tool/bowtie2/version/2.2.8.
881881
If supported by a given registry, implementations are encouraged to
882-
query these system independent sofware identifier IRIs directly for
882+
query these system independent software identifier IRIs directly for
883883
links to packaging systems.
884884
885885
A site specific IRI can be listed as well. For example, an academic
886-
computing cluster using Environement Modules could list the IRI
886+
computing cluster using Environment Modules could list the IRI
887887
`https://hpc.example.edu/modules/bowtie-tbb/1.22` to indicate that
888888
`module load bowtie-tbb/1.1.2` should be executed to make available
889889
`bowtie` version 1.1.2 compiled with the TBB library prior to running
@@ -1234,7 +1234,7 @@ $graph:
12341234
For implementations that support reusing output from past work (on
12351235
the assumption that same code and same input produce same
12361236
results), control whether to enable or disable the reuse behavior
1237-
for a particular tool or step (to accomodate situations where that
1237+
for a particular tool or step (to accommodate situations where that
12381238
assumption is incorrect). A reused step is not executed but
12391239
instead returns the same output as the original execution.
12401240
@@ -1269,7 +1269,7 @@ $graph:
12691269
may apply their own security policies to restrict what is
12701270
accessible by the tool.
12711271
1272-
Enabling network access does not imply a publically routable IP
1272+
Enabling network access does not imply a publicly routable IP
12731273
address or the ability to accept inbound connections.
12741274
12751275
fields:
@@ -1302,7 +1302,7 @@ $graph:
13021302
read-only in every step.
13031303
13041304
Workflow steps which modify a file must produce the modified file
1305-
as output. Downstream steps which futher process the file must
1305+
as output. Downstream steps which further process the file must
13061306
use the output of previous steps, and not refer to a common input
13071307
(this is necessary for both ordering and correctness).
13081308

0 commit comments

Comments
 (0)