Skip to content

Add debugger build workflow and README install instructions #581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rentziass merged 1 commit into from
Apr 8, 2026
Merged

Add debugger build workflow and README install instructions #581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/workflows/debugger-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Build Debugger Extension

on:
push:
branches:
- debugger

permissions:
contents: read
packages: read

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 16.x
cache: "npm"
registry-url: "https://npm.pkg.github.com"

- run: npm --no-git-tag-version version 0.0.${{ github.run_number }}

- run: npm ci
env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- 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

Comment on lines +31 to +37
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copilot uses AI. Check for mistakes.
- uses: actions/upload-artifact@v4
with:
name: vscode-github-actions-debugger
path: ./vscode-github-actions-0.0.${{ github.run_number }}.vsix
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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…**.
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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…**.

Copilot uses AI. Check for mistakes.

The GitHub Actions extension lets you manage your workflows, view the workflow run history, and helps with authoring workflows.

![](./media/header.png)
Expand Down
Loading