Skip to content

Commit ba15a00

Browse files
authored
Merge pull request #373 from coderoad/docs/build-update
update docs for build cli v0.4
2 parents e08166e + e229cb8 commit ba15a00

File tree

6 files changed

+153
-145
lines changed

6 files changed

+153
-145
lines changed

Diff for: docs/docs/config-yml.md

+8-33
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,6 @@ config:
4040
directory: coderoad
4141
## Commits to load to setup the test runner. Optional.
4242
setup:
43-
## A list of commits to load to setup the tutorial
44-
commits:
45-
- commit1
46-
- commit2
4743
## A list of commands to run to configure the tutorial
4844
commands:
4945
- npm install
@@ -57,7 +53,7 @@ config:
5753
## The uri path to the repo containing the code commits. Required.
5854
uri: https://github.com/coderoad/fcc-learn-npm
5955
## The branch on the repo uri that contains the code commits. Required.
60-
branch: v0.3.0
56+
branch: v0.4.1
6157
## A list of tutorial dependencies to ensure the environment is setup for the tutorial. Optional.
6258
## The dependencies will be checked by running `dependency.name` --version and comparing it to the version provided.
6359
##
@@ -68,31 +64,23 @@ config:
6864
version: '>=10'
6965
## A level is made up of
7066
levels:
71-
- id: L1
67+
- id: '1'
7268
steps:
7369
## Example 1: Opening files
74-
- id: L1S1
70+
- id: '1.1'
7571
## Setup for the first task. Required.
7672
setup:
7773
## Files to open in a text editor when the task loads. Optional.
7874
files:
7975
- package.json
80-
## Commits to load when the task loads. These should include failing tests. Required.
81-
commits:
82-
- commit3
8376
## Solution for the first task. Required.
8477
solution:
8578
## Files to open when the solution loads. Optional.
8679
files:
8780
- package.json
88-
## Commits that complete the task. All tests should pass when the commits load. These commits will not be loaded by the tutorial user in normal tutorial activity.
89-
commits:
90-
- commit4
9181
## Example Two: Running commands
92-
- id: L1S2
82+
- id: '1.2'
9383
setup:
94-
commits:
95-
- commit5
9684
## CLI commands that are run when the task loads. Optional.
9785
commands:
9886
- npm install
@@ -102,12 +90,10 @@ levels:
10290
commands:
10391
- npm install
10492
## Example Three: Watchers
105-
- id: L1S3
93+
- id: '1.3'
10694
setup:
10795
files:
10896
- package.json
109-
commits:
110-
- commit7
11197
## Listeners that run tests when a file or directory changes.
11298
watchers:
11399
- package.json
@@ -118,25 +104,14 @@ levels:
118104
commits:
119105
- commit8
120106
## Example Four: Subtasks
121-
- id: L1S4
107+
- id: '1.4'
122108
setup:
123-
commits:
124-
- commit8
125109
commands:
126110
## A filter is a regex that limits the test results
127111
- filter: '^Example 2'
128112
## A feature that shows subtasks: all filtered active test names and the status of the tests (pass/fail).
129113
- subtasks: true
130-
solution:
131-
commits:
132-
- commit9
133-
- id: L2
114+
- id: '2'
134115
steps:
135-
- id: L2S1
136-
setup:
137-
commits:
138-
- commit10
139-
solution:
140-
commits:
141-
- commit7
116+
- id: '2.1'
142117
```

0 commit comments

Comments
 (0)