Error Occurs When Following Instructions in development.md
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- node.js, typescript, webpack
- Domain
- build-system, devtools
Research direction
Start with development.md and reproduce the failure using script/bootstrap, npm i, and npm run build -ws. Inspect src/context-providers/secrets.ts around line 138 and src/workflow/languageServer.ts around line 6, then compare the dependency installation steps with the reported TypeScript errors. Done means the documented setup completes and the workspaces build successfully.
Written by the indexing model from the issue text.
Description
Describe the bug
Upon following the instructions in the development.md file for creating my own local development environment, after running npm run build -ws it begins building the workspaces and then eventually fails.
The first error that occurs is:
src/context-providers/secrets.ts:138:7 - error TS2769: No overload matches this call.
Overload 1 of 9, '(route: keyof PaginatingEndpoints, parameters: { per_page?: number | undefined; cursor?: string | undefined; redelivery?: boolean | undefined; } | { per_page?: number | undefined; page?: number | undefined; } | ... 219 more ... | ({ ...; } & { ...; }), mapFn: MapFunction<...>): Promise<...>', gave the following error.
Argument of type '{ (params?: (RequestParameters & Omit<ToOctokitParameters<{ parameters: { query?: { per_page?: number | undefined; page?: number | undefined; } | undefined; path: { owner: string; repo: string; }; }; responses: { ...; }; }>, "baseUrl" | ... 1 more ... | "mediaType">) | undefined): Promise<...>; defaults: <O extends ...' is not assignable to parameter of type 'keyof PaginatingEndpoints'.
Overload 2 of 9, '(request: RequestInterface<object>, parameters: string, mapFn: MapFunction<NormalizeResponse<OctokitResponse<any, number>>, StringData[]>): Promise<...>', gave the following error.
Argument of type '{ (params?: (RequestParameters & Omit<ToOctokitParameters<{ parameters: { query?: { per_page?: number | undefined; page?: number | undefined; } | undefined; path: { owner: string; repo: string; }; }; responses: { ...; }; }>, "baseUrl" | ... 1 more ... | "mediaType">) | undefined): Promise<...>; defaults: <O extends ...' is not assignable to parameter of type 'RequestInterface<object>'.
The types of 'defaults(...).defaults(...).endpoint.DEFAULTS' are incompatible between these types.
Type 'object & O & O & import("/Users/nico/vscode/node_modules/@octokit/plugin-rest-endpoint-methods/node_modules/@octokit/types/dist-types/RequestParameters").RequestParameters & { ...; }' is not assignable to type 'object & O & O & import("/Users/nico/vscode/node_modules/@octokit/types/dist-types/RequestParameters").RequestParameters & { baseUrl: string; method: import("/Users/nico/vscode/node_modules/@octokit/types/dist-types/RequestMethod").RequestMethod; url?: string | undefined; headers: import("/Users/nico/vscode/node_mod...'.
Type 'object & O & O & RequestParameters & { baseUrl: string; method: RequestMethod; url?: string | undefined; headers: RequestHeaders & { ...; }; mediaType: { ...; }; }' is not assignable to type '{ baseUrl: string; method: RequestMethod; url?: string | undefined; headers: RequestHeaders & { accept: string; "user-agent": string; }; mediaType: { format: string; previews: string[]; }; }'.
The types of 'mediaType.previews' are incompatible between these types.
Type 'string[] | undefined' is not assignable to type 'string[]'.
Type 'undefined' is not assignable to type 'string[]'.
138 octokit.actions.listRepoSecrets,
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The last messages in my console are:
ERROR in /Users/nico/vscode/vscode-github-actions/src/workflow/languageServer.ts
6:40-73
[tsl] ERROR in /Users/nico/vscode/vscode-github-actions/src/workflow/languageServer.ts(6,41)
TS2307: Cannot find module '@actions/languageserver/request' or its corresponding type declarations.
18 errors have detailed information that is not shown.
Use 'stats.errorDetails: true' resp. '--stats-error-details' to show it.
webpack 5.97.0 compiled with 18 errors in 5492 ms
npm error Lifecycle script `build` failed with error:
npm error code 1
npm error path /Users/nico/vscode/vscode-github-actions
npm error workspace @github/vscode-github-actions@0.27.0
npm error location /Users/nico/vscode/vscode-github-actions
npm error command failed
npm error command sh -c webpack --mode production
Here is a pastebin of the full console output: https://pastebin.com/mSmvakEM
To Reproduce
Steps to reproduce the behavior (follow instructions in development.md)
mkdir ~/vscode
cd ~/vscode
git clone https://github.com/github/vscode-github-actions.git # Note I used `git clone` instead of `gh repo clone`
cd vscode-github-actions
script/bootstrap
cd ~/vscode
npm i
npm run build -ws
When this threw an error, I followed the instructions further:
If npm run build -ws fails because packages are not installed correctly with npm i, re-run script/bootstrap and run npm ci to get working packages.
cd vscode-github-actions
script/bootstrap
cd ~/vscode
npm install
npm ci
Expected behavior
According to the development.md file, setting up the workspace should just work:
Launching and debugging the extension should just work.
So I should be able to just run these commands, install the necessary packages, and build the necessary workspaces.
Screenshots
Extension Version
According to release-notes.txt the version is 0.25.6
- Dominant language
- TypeScript
- Stars
- 661
- Forks
- 214
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/vscode-github-actions
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
github/vscode-github-actions#627 · 1 reaction ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
github/vscode-github-actions#630 · 1 reaction ·
-
long work Open
Difficulty 4/5 3-5 days Newbie friendliness 25/100
github/vscode-github-actions#628 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 55/100
github/vscode-github-actions#625 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 64/100
github/vscode-github-actions#621 · 3 comments ·
All issues in github/vscode-github-actions
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
bcgov/bc-wallet-mobile#4761 · 1 comment ·
-
external-issue to-triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
area-deployment area-integrations triage:bot-seen
Difficulty 2/5 Half a day Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
refactor
Difficulty 2/5 1-3 hours Newbie friendliness 84/100