You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+42-28Lines changed: 42 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,90 +34,105 @@ These are one time installations required to be able to test your changes locall
34
34
1. Install [Node.js](https://nodejs.org/en/download/) for your platform
35
35
1. Install [VS Code](https://code.visualstudio.com/download) for your platform
36
36
1. Install the dependencies. From the repository root run:
37
+
37
38
```bash
38
-
$ npm i
39
+
npm i
39
40
```
40
41
41
-
## Making & testing changes
42
+
## Dev loop & Testing changes
43
+
44
+
The extension is written in TypeScript and built using [webpack](https://webpack.js.org/). The dev loop steps and commands have been tested on both Mac and Windows.
45
+
46
+
1. Go to the Debug tab.
47
+
1. Hit `Watch all & Launch Extension (workspace)` if you want to work on the main VS Code extension like the left sidebar and the UI for the extension.
48
+
1. Hit `Watch & Launch Extension + language-server (workspace)` if you want to work on the language services code and want to debug and work on the hover, syntax highlighting, and other functionality within the Workflow files.
49
+
* This will attach to an instance of the language server running on port `6010`
50
+
1. Hit the play button (this will automatically run `npm watch` for you and monitor for changes) which will open a local version of the extension using the _extension development host_.
51
+
1. Make changes.
52
+
1. To get new changes, hit the refresh button in the debugger window to reload the extension in the development host. _If you don't see the changes, wait long enough for the `npm watch` terminal to rebuild and then try hitting the play button again._
The extension is written in TypeScript and built using [webpack](https://webpack.js.org/).
58
+
For the commands below make sure that you are in the `vscode-github-actions` directory of your local repo first.
59
+
60
+
```bash
61
+
cd vscode-github-actions
62
+
```
44
63
45
64
### Build
46
65
47
66
Build changes (one time):
48
67
49
68
```bash
50
-
$ npm run build
69
+
npm run build
51
70
```
52
71
53
72
Or to watch for changes and automatically rebuild every time on save:
54
73
55
74
```bash
56
-
$ npm run watch
75
+
npm run watch
57
76
```
58
77
59
-
### Testing changes
60
-
61
-
1. Open the repository in VS Code
62
-
1. Run one of the debug targets:
63
-
* "Watch & Launch extension" - watch extension files, compile as necessary, and run the extension using the _extension development host_
64
-
* "Attach to Language-Server" - attach to an instance of the language server running on port `6010`
65
-
* "Run Web Extension in VS Code" - run the [web version](https://code.visualstudio.com/api/extension-guides/web-extensions) of the extension
66
-
67
-
### Dev loop
68
-
1. Setup `Watch all & Launch Extension` under Debug and hit the green button
69
-
1.`npm run watch`
70
-
1. Make change
71
-
1. Hit the refresh button in the debugger window to reload the extension in the development host
72
-
73
78
### Running tests
74
79
75
80
```bash
76
-
$ npm test
81
+
npm test
77
82
```
78
83
79
84
Or to watch for changes and run tests:
80
85
81
86
```bash
82
-
$ npm run test-watch
87
+
npm run test-watch
83
88
```
84
89
85
90
### Lint
86
91
87
92
```bash
88
-
$ npm run lint
93
+
npm run lint
89
94
```
90
95
91
96
Run linter and fix errors as possible:
92
97
93
98
```bash
94
-
$ npm run lint-fix
99
+
npm run lint-fix
95
100
```
96
101
97
102
### Format
98
103
99
104
Check formatting with [prettier](https://prettier.io/):
100
105
101
106
```bash
102
-
$ npm run format-check
107
+
npm run format-check
103
108
```
104
109
105
110
Run prettier and automatically format:
106
111
107
112
```bash
108
-
$ npm run format
113
+
npm run format
109
114
```
110
115
111
116
### Package the extension
112
117
113
118
```bash
114
-
$ npm run package
119
+
npm run package
115
120
```
116
121
122
+
### Run Web Extension
123
+
124
+
"Run Web Extension in VS Code" - run the [web version](https://code.visualstudio.com/api/extension-guides/web-extensions) of the extension
125
+
126
+
## VS Code Source Control Repositories
127
+
128
+
If you don't see `vscode-github-actions` and `languageservices`, please go to `Preferences: Open User Settings` and then search for `git.openRepositoryInParentFolders` and you can set it to `always` and it will show all of the associated repos for the Workspace.
0 commit comments