Skip to content

Commit ce2e110

Browse files
ShMcKShMcK
committed
cleanup changelog
Signed-off-by: shmck <[email protected]>
1 parent 312ac1a commit ce2e110

File tree

1 file changed

+171
-162
lines changed

1 file changed

+171
-162
lines changed

‎CHANGELOG.md

+171-162
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,107 @@ All notable changes to the "coderoad-vscode" extension will be documented in thi
44

55
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
66

7+
## [0.16.0]
8+
9+
- add support for writing session state to a file. This is useful in multi-container environments where local storage is not necessarily preserved across sessions.
10+
11+
## [0.15.1]
12+
13+
- fixes bug where CodeRoad would not run in some containerized environments due to the event origin path
14+
15+
## [0.15.0]
16+
17+
- Webhook support
18+
- Updated Settings page
19+
- Reset tutorial button
20+
- New env variable: CODEROAD_CONTENT_SECURITY_POLICY_EXEMPTIONS
21+
- CodeRoad launches automatically if repo includes `codeally.json`
22+
23+
## [0.14.1]
24+
25+
- Resolve issues with error pages
26+
- Include better errors for supporting Windows
27+
28+
## [0.14.0]
29+
30+
- Add logo to vscode marketplace
31+
- Fixes
32+
- issue with watcher tests running on reset
33+
- issue with some commits loading multiple times on continue
34+
- issue with task progress not displaying correctly
35+
36+
## [0.13.0]
37+
38+
- BREAKING CHANGE:
39+
- `config.testRunner.setup` is now `config.setup`
40+
- `config.setup` runs in the root workspace directory, not the `config.testRunner.directory`
41+
- Significant internal refactor to:
42+
- remove recording progress
43+
- simplify structure with "hooks"
44+
- Supports commands on reset
45+
- Supports running vscode commands anywhere that command line commands can be run
46+
- Admin mode to allow creators to jump between tutorial levels/steps during development
47+
48+
## [0.12.0]
49+
50+
- Change completion page to a banner that prompts the user to open a new workspace
51+
- On launch, show details on tutorial to continue
52+
- Adds an "About" section to the tutorial side menu
53+
- Run test indicator
54+
- Various style & UX fixes
55+
- Launch from URL fixes
56+
- Move styles into a central theme
57+
- Prevent multiple versions of CodeRoad from launching
58+
59+
## [0.11.0]
60+
61+
- Improved UI for continue
62+
- show overall level progress
63+
- popup on level completion
64+
- Hotkey support for:
65+
- running tests (ctrl + enter)
66+
- continue (ctrl + enter)
67+
- Fix scroll to bottom on next level
68+
- Add a scroll indicator when content is too long
69+
70+
## [0.10.0]
71+
72+
UI redesign for the tutorial page:
73+
74+
- removes unnecessary headers
75+
- adds a side panel
76+
- step progress indicator
77+
- removes logs from error messges
78+
79+
Supports "reset button" for resetting state & running a reset script.
80+
81+
Adds a review page for viewing tutorial content. The review page should be especially helpful for tutorial creators.
82+
83+
## [0.9.0]
84+
85+
Change subtask format to include subtasks in markdown.
86+
87+
Subtasks no longer need to be included in yaml, or require a filter.
88+
89+
See an example at <http://github.com/shmck/coderoad-tutorial-subtask-demo>
90+
91+
```md
92+
### 1.1
93+
94+
A description of the task
95+
96+
#### SUBTASKS
97+
98+
- The first subtask
99+
- The second subtask
100+
```
101+
102+
Subtasks are then matched up with tests with names that match
103+
104+
```text
105+
SUBTASK 1.1 :1 test name
106+
SUBTASK 1.2 :2 test name
107+
7108
## [0.1.0]
8109
9110
- Initial release
@@ -38,94 +139,24 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
38139
}
39140
```
40141

41-
## [0.2.2]
42-
43-
- Fixes issue where app fails on startup without a workspace, and instead returns an error page
44-
45-
## [0.2.3]
46-
47-
- Support Windows OS
48-
49-
## [0.2.4]
50-
51-
- Support VSCode 1.39.2
52-
53-
## [0.3.0]
54-
55-
- Validate the extension version against the tutorial config version. This should allow us to manage breaking changes in tutorial schema in upcoming versions. See [node-semver](https://github.com/npm/node-semver#advanced-range-syntax) for possible version ranges and options.
56-
57-
```json
58-
{
59-
"config": {
60-
"appVersions": {
61-
"vscode": ">=0.2"
62-
},
63-
}
64-
```
65-
66-
- Configure the CodeRoad to load and run in a different directory. The example below will:
67-
- load a commit and run npm install to setup the test runner in its own folder.
68-
- run "npm test" in the \$ROOT/coderoad directory on save
69-
70-
```json
71-
{
72-
"config": {
73-
"testRunner": {
74-
"command": "npm test", // runs in path location or root
75-
"path": "coderoad",
76-
"actions": {
77-
"commits": ["a974aea"],
78-
"commands": ["npm install"] // runs in path location or root
79-
}
80-
},
81-
}
82-
```
83-
84-
Resulting in a folder structure like the following:
85-
86-
```text
87-
- .vscode
88-
- coderoad (test runner files only with their own setup)
89-
- package.json
90-
- tests
91-
- package.json
92-
- server.js
93-
```
94-
95-
## [0.4.0]
96-
97-
- Want to look back at a previous lesson's content? Navigate through text content from previous levels by clicking the "Learn" dropdown.
98-
99-
![traverse content](./docs/images/traverse-content.png)
100-
101-
- Continue an incomplete tutorial started in the same workspace. Choose the "continue" path from the start screen. Progress is stored in local storage in the workspace.
102-
103-
![continue tutorial](./docs/images/continue-tutorial.png)
104-
105-
## [0.5.0]
106-
107-
- Show test fail messages in the webview UI
142+
## [0.8.0]
108143

109-
![fail message in webview](./docs/images/fail-message-in-webview.png)
144+
- Support Python with using [tap.py](https://github.com/python-tap/tappy)
145+
- Fix paragraph spacing
146+
- Support hints - clues that reveal on click to help guide users. Hints can be added to a step, see an example below.
110147

111-
- Display error messages if React fails to load
148+
```md
149+
### 1.1
112150

113-
## [0.6.0]
151+
A description of the task.
114152

115-
- New configuration environment variables for web compatability
153+
#### HINTS
116154

117-
```text
118-
CODEROAD_DISABLE_RUN_ON_SAVE=true // blocks saving on file system changes
119-
CODEROAD_DISPLAY_RUN_TEST_BUTTON=true // adds a run test button to tutorial page
120-
CODEROAD_TUTORIAL_URL='path/to/tutorial_config_file.json' // will load directly into tutorial
155+
- The first hint
156+
- The second hint
157+
- The last hint
121158
```
122159

123-
- Improves styles for inline code blocks
124-
125-
## [0.6.1]
126-
127-
- Replace checkboxes with icons
128-
129160
## [0.7.0]
130161

131162
- Style fixes for tables & bold markdown
@@ -158,114 +189,92 @@ CODEROAD_TUTORIAL_URL='path/to/tutorial_config_file.json' // will load directly
158189
}
159190
```
160191

161-
### [0.8.0]
162192

163-
- Support Python with using [tap.py](https://github.com/python-tap/tappy)
164-
- Fix paragraph spacing
165-
- Support hints - clues that reveal on click to help guide users. Hints can be added to a step, see an example below.
193+
## [0.6.1]
166194

167-
```md
168-
### 1.1
195+
- Replace checkboxes with icons
169196

170-
A description of the task.
197+
## [0.6.0]
171198

172-
#### HINTS
199+
- New configuration environment variables for web compatability
173200

174-
- The first hint
175-
- The second hint
176-
- The last hint
201+
```text
202+
CODEROAD_DISABLE_RUN_ON_SAVE=true // blocks saving on file system changes
203+
CODEROAD_DISPLAY_RUN_TEST_BUTTON=true // adds a run test button to tutorial page
204+
CODEROAD_TUTORIAL_URL='path/to/tutorial_config_file.json' // will load directly into tutorial
177205
```
178206

179-
### [0.9.0]
180-
181-
Change subtask format to include subtasks in markdown.
182-
183-
Subtasks no longer need to be included in yaml, or require a filter.
184-
185-
See an example at <http://github.com/shmck/coderoad-tutorial-subtask-demo>
207+
- Improves styles for inline code blocks
186208

187-
```md
188-
### 1.1
209+
## [0.5.0]
189210

190-
A description of the task
211+
- Show test fail messages in the webview UI
191212

192-
#### SUBTASKS
213+
![fail message in webview](./docs/images/fail-message-in-webview.png)
193214

194-
- The first subtask
195-
- The second subtask
196-
```
215+
- Display error messages if React fails to load
197216

198-
Subtasks are then matched up with tests with names that match
217+
## [0.4.0]
199218

200-
```text
201-
SUBTASK 1.1 :1 test name
202-
SUBTASK 1.2 :2 test name
203-
```
219+
- Want to look back at a previous lesson's content? Navigate through text content from previous levels by clicking the "Learn" dropdown.
204220

205-
### [0.10.0]
221+
![traverse content](./docs/images/traverse-content.png)
206222

207-
UI redesign for the tutorial page:
223+
- Continue an incomplete tutorial started in the same workspace. Choose the "continue" path from the start screen. Progress is stored in local storage in the workspace.
208224

209-
- removes unnecessary headers
210-
- adds a side panel
211-
- step progress indicator
212-
- removes logs from error messges
225+
![continue tutorial](./docs/images/continue-tutorial.png)
213226

214-
Supports "reset button" for resetting state & running a reset script.
215227

216-
Adds a review page for viewing tutorial content. The review page should be especially helpful for tutorial creators.
228+
## [0.3.0]
217229

218-
### [0.11.0]
230+
- Validate the extension version against the tutorial config version. This should allow us to manage breaking changes in tutorial schema in upcoming versions. See [node-semver](https://github.com/npm/node-semver#advanced-range-syntax) for possible version ranges and options.
219231

220-
- Improved UI for continue
221-
- show overall level progress
222-
- popup on level completion
223-
- Hotkey support for:
224-
- running tests (ctrl + enter)
225-
- continue (ctrl + enter)
226-
- Fix scroll to bottom on next level
227-
- Add a scroll indicator when content is too long
232+
```json
233+
{
234+
"config": {
235+
"appVersions": {
236+
"vscode": ">=0.2"
237+
},
238+
}
239+
```
228240

229-
### [0.12.0]
241+
- Configure the CodeRoad to load and run in a different directory. The example below will:
242+
- load a commit and run npm install to setup the test runner in its own folder.
243+
- run "npm test" in the \$ROOT/coderoad directory on save
230244

231-
- Change completion page to a banner that prompts the user to open a new workspace
232-
- On launch, show details on tutorial to continue
233-
- Adds an "About" section to the tutorial side menu
234-
- Run test indicator
235-
- Various style & UX fixes
236-
- Launch from URL fixes
237-
- Move styles into a central theme
238-
- Prevent multiple versions of CodeRoad from launching
245+
```json
246+
{
247+
"config": {
248+
"testRunner": {
249+
"command": "npm test", // runs in path location or root
250+
"path": "coderoad",
251+
"actions": {
252+
"commits": ["a974aea"],
253+
"commands": ["npm install"] // runs in path location or root
254+
}
255+
},
256+
}
257+
```
239258

240-
### [0.13.0]
259+
Resulting in a folder structure like the following:
241260

242-
- BREAKING CHANGE:
243-
- `config.testRunner.setup` is now `config.setup`
244-
- `config.setup` runs in the root workspace directory, not the `config.testRunner.directory`
245-
- Significant internal refactor to:
246-
- remove recording progress
247-
- simplify structure with "hooks"
248-
- Supports commands on reset
249-
- Supports running vscode commands anywhere that command line commands can be run
250-
- Admin mode to allow creators to jump between tutorial levels/steps during development
261+
```text
262+
- .vscode
263+
- coderoad (test runner files only with their own setup)
264+
- package.json
265+
- tests
266+
- package.json
267+
- server.js
268+
```
251269

252-
### [0.14.0]
270+
## [0.2.4]
253271

254-
- Add logo to vscode marketplace
255-
- Fixes
256-
- issue with watcher tests running on reset
257-
- issue with some commits loading multiple times on continue
258-
- issue with task progress not displaying correctly
272+
- Support VSCode 1.39.2
259273

260-
### [0.14.1]
274+
## [0.2.3]
261275

262-
- Resolve issues with error pages
263-
- Include better errors for supporting Windows
276+
- Support Windows OS
264277

265-
### [0.15.0]
278+
## [0.2.2]
266279

267-
- Webhook support
268-
- Updated Settings page
269-
- Reset tutorial button
270-
- New env variable: CODEROAD_CONTENT_SECURITY_POLICY_EXEMPTIONS
271-
- CodeRoad launches automatically if repo includes `codeally.json`
280+
- Fixes issue where app fails on startup without a workspace, and instead returns an error page

0 commit comments

Comments
 (0)