Skip to content

Commit 66eb588

Browse files
committed
[exercises] Update README
1 parent e579771 commit 66eb588

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Configuration fields for each exercise:
1515
4. `requires_github`: downloading the exercise will check that Github and Github CLI is installed
1616
5. `base_files`: provides the files to be included outside of the repository, along with `.gitmastery-exercise.json` and `README.md`, most often used for `answers.txt`
1717
6. `exercise_repo`: configuration for what the exercise repository would look like
18-
1. `type`: `custom` (creates and initializes the folder as a Git repository) or `link` (reference a repository on Github)
19-
2. `name`: name of repository during cloning
20-
3. `link`: (only read if `link` is present) link of repository on Github
18+
1. `repo_type`: `local` (creates and initializes the folder as a Git repository) or `remote` (reference a repository on Github)
19+
2. `repo_name`: name of repository during cloning
20+
3. `repo_title`: (only read if `link` is present) link of repository on Github
2121
4. `create_fork`: (only read if `link` is present) flag to determine if we need to fork the repository to the student's machine, otherwise it just clones the repository
2222
5. `init`: (only read if `custom` is present) flag to determine if we will call `git init` on the exercise repository (useful if we don't want to start out with a Git repository)
2323

2424

2525
## TODOs
2626

27-
- [ ] Add validation for exercise configuration (e.g. cannot fork + not require Github) - to run as CI
27+
- [X] Add validation for exercise configuration (e.g. cannot fork + not require Github) - to run as CI

0 commit comments

Comments
 (0)