- Notifications
You must be signed in to change notification settings - Fork39
add config yaml docs#356
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
142 changes: 142 additions & 0 deletionsdocs/docs/config-yml.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
--- | ||
id: config-file | ||
title: Config File | ||
sidebar_label: Config File | ||
--- | ||
An overview of the yaml configuration. | ||
```yaml | ||
# A configuration file for a CodeRoad Tutorial | ||
# This is a YAML-formatted file. | ||
## Your personal version of the tutorial | ||
## | ||
version: '0.1.0' | ||
## Data used to populate the tutorial summary page | ||
## | ||
summary: | ||
## The title of your tutorial. Required. | ||
## | ||
title: '' | ||
## A description of your tutorial. Required. | ||
## | ||
description: '' | ||
## Data used to configure and setup the tutorial | ||
## | ||
config: | ||
## Test runner setup. | ||
testRunner: | ||
## The command called to run the test runner. For example "npm run test", or a path to the test runner binary. Required. | ||
command: ./node_modules/.bin/mocha | ||
## Standard arguments used by a given test runner | ||
args: | ||
## The command arg used to filter tests. Used by "subtasks" | ||
filter: --grep | ||
## The command arg used to convert test runner output to TAP format. See https://testanything.org/ for more. Required. | ||
tap: --reporter=mocha-tap-reporter | ||
## The directory where to run the test runner from. If not specified, tests will run from the root of the project. Optional. | ||
directory: coderoad | ||
## Commits to load to setup the test runner. Optional. | ||
setup: | ||
## A list of commits to load to setup the tutorial | ||
commits: | ||
- commit1 | ||
- commit2 | ||
## A list of commands to run to configure the tutorial | ||
commands: | ||
- npm install | ||
## App versions helps to ensure compatability with the Extension | ||
appVersions: | ||
## Ensure compatability with a minimal VSCode CodeRoad version | ||
vscode: '>=0.7.0' | ||
## Repo information to load code from | ||
## | ||
repo: | ||
## The uri path to the repo containing the code commits. Required. | ||
uri: https://github.com/coderoad/fcc-learn-npm | ||
## The branch on the repo uri that contains the code commits. Required. | ||
branch: v0.3.0 | ||
## A list of tutorial dependencies to ensure the environment is setup for the tutorial. Optional. | ||
## The dependencies will be checked by running `dependency.name` --version and comparing it to the version provided. | ||
## | ||
dependencies: | ||
## The name of the dependency | ||
- name: node | ||
## The version requirement. See https://github.com/npm/node-semver for options. | ||
version: '>=10' | ||
## A level is made up of | ||
levels: | ||
- id: L1 | ||
steps: | ||
## Example 1: Opening files | ||
- id: L1S1 | ||
## Setup for the first task. Required. | ||
setup: | ||
## Files to open in a text editor when the task loads. Optional. | ||
files: | ||
- package.json | ||
## Commits to load when the task loads. These should include failing tests. Required. | ||
commits: | ||
- commit3 | ||
## Solution for the first task. Required. | ||
solution: | ||
## Files to open when the solution loads. Optional. | ||
files: | ||
- package.json | ||
## 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. | ||
commits: | ||
- commit4 | ||
## Example Two: Running commands | ||
- id: L1S2 | ||
setup: | ||
commits: | ||
- commit5 | ||
## CLI commands that are run when the task loads. Optional. | ||
commands: | ||
- npm install | ||
solution: | ||
commits: | ||
- commit6 | ||
commands: | ||
- npm install | ||
## Example Three: Watchers | ||
- id: L1S3 | ||
setup: | ||
files: | ||
- package.json | ||
commits: | ||
- commit7 | ||
## Listeners that run tests when a file or directory changes. | ||
watchers: | ||
- package.json | ||
- node_modules/some-package | ||
solution: | ||
files: | ||
- package.json | ||
commits: | ||
- commit8 | ||
## Example Four: Subtasks | ||
- id: L1S4 | ||
setup: | ||
commits: | ||
- commit8 | ||
commands: | ||
## A filter is a regex that limits the test results | ||
- filter: '^Example 2' | ||
## A feature that shows subtasks: all filtered active test names and the status of the tests (pass/fail). | ||
- subtasks: true | ||
solution: | ||
commits: | ||
- commit9 | ||
- id: L2 | ||
steps: | ||
- id: L2S1 | ||
setup: | ||
commits: | ||
- commit10 | ||
solution: | ||
commits: | ||
- commit7 | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.