Add debugger build workflow and README install instructions#581
Merged
Add debugger build workflow and README install instructions#581
Conversation
Agent-Logs-Url: https://github.com/github/vscode-github-actions/sessions/5c79f4b5-d19e-4768-8821-d2721886fc0e Co-authored-by: rentziass <[email protected]>
There was a problem hiding this comment.
Pull request overview
Adds a dedicated GitHub Actions workflow to build and upload a “debugger” VS Code extension VSIX, and documents how to install that build from CI artifacts.
Changes:
- Add a new
debugger-build.ymlworkflow that packages a debugger extension VSIX and uploads it as an artifact. - Add README instructions for downloading and installing the debugger VSIX from the workflow artifacts.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds end-user instructions for installing the debugger preview build from workflow artifacts. |
| .github/workflows/debugger-build.yml | Introduces a new CI workflow to package and upload a debugger VSIX artifact. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 2
| @@ -1,5 +1,7 @@ | |||
| # GitHub Actions for VS Code | |||
|
|
|||
| > **🐛 Actions Job Debugger (Preview):** To try the latest debugger build, download the `.vsix` artifact from the most recent [Build Debugger Extension](https://github.com/github/vscode-github-actions/actions/workflows/debugger-build.yml) workflow run. On the workflow run page, scroll to **Artifacts** and download **vscode-github-actions-debugger**. Then install it in VS Code by running `code --install-extension <path-to-downloaded.vsix>` or via the Extensions view → `⋯` menu → **Install from VSIX…**. | |||
There was a problem hiding this comment.
GitHub Actions artifacts are downloaded as a .zip file (even when the artifact contains a single .vsix). The current wording suggests downloading a “.vsix artifact” directly; please clarify that users should download the artifact zip and extract the .vsix before running code --install-extension (or installing via VS Code UI).
Suggested change
| > **🐛 Actions Job Debugger (Preview):** To try the latest debugger build, download the `.vsix` artifact from the most recent [Build Debugger Extension](https://github.com/github/vscode-github-actions/actions/workflows/debugger-build.yml) workflow run. On the workflow run page, scroll to **Artifacts** and download **vscode-github-actions-debugger**. Then install it in VS Code by running `code --install-extension <path-to-downloaded.vsix>` or via the Extensions view → `⋯` menu → **Install from VSIX…**. | |
| > **🐛 Actions Job Debugger (Preview):** To try the latest debugger build, go to the most recent [Build Debugger Extension](https://github.com/github/vscode-github-actions/actions/workflows/debugger-build.yml) workflow run. On the workflow run page, scroll to **Artifacts** and download **vscode-github-actions-debugger**. GitHub Actions artifacts download as a `.zip` file, so extract the contained `.vsix` file first, then install it in VS Code by running `code --install-extension <path-to-extracted.vsix>` or via the Extensions view → `⋯` menu → **Install from VSIX…**. |
Comment on lines
+31
to
+37
| - name: Create a package.json without scoped name | ||
| run: | | ||
| cp package.json package.json.real | ||
| sed --regexp-extended '/"name"\s*:/ s#@[a-zA-Z\\-]+/##' package.json.real > package.json | ||
|
|
||
| - run: npm run package | ||
|
|
There was a problem hiding this comment.
This step leaves a temporary package.json.real in the workspace. Since vsce package includes files unless excluded by .vscodeignore/files, the generated VSIX will likely contain package.json.real as an extra file. Consider deleting the temp file before packaging or writing it to a temp location, or explicitly excluding it in .vscodeignore.
Suggested change
| - name: Create a package.json without scoped name | |
| run: | | |
| cp package.json package.json.real | |
| sed --regexp-extended '/"name"\s*:/ s#@[a-zA-Z\\-]+/##' package.json.real > package.json | |
| - run: npm run package | |
| - name: Create a package.json without scoped name and package extension | |
| run: | | |
| TEMP_PACKAGE_JSON="$RUNNER_TEMP/package.json.real" | |
| cp package.json "$TEMP_PACKAGE_JSON" | |
| cleanup() { | |
| cp "$TEMP_PACKAGE_JSON" package.json | |
| rm -f "$TEMP_PACKAGE_JSON" | |
| } | |
| trap cleanup EXIT | |
| sed --regexp-extended '/"name"\s*:/ s#@[a-zA-Z\\-]+/##' "$TEMP_PACKAGE_JSON" > package.json | |
| npm run package |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Agent-Logs-Url: https://github.com/github/vscode-github-actions/sessions/5c79f4b5-d19e-4768-8821-d2721886fc0e