Merge remote-tracking branch 'upstream/main' into dev/rigibson/integration-test-restore

Author: RikkiGibson

.azuredevops/policies/branchClassification.yml

@@ -0,0 +1,19 @@
+name: branch_classification
+description: Branch classification configuration for repository
+resource: repository
+disabled: false
+where:
+configuration:
+  branchClassificationSettings:
+    defaultClassification: nonproduction
+    ruleset:
+    - name: prod-branches
+      branchNames:
+      - main
+      - prerelease
+      - release
+      classification: production
+    - name: nonprod-branches
+      branchNames:
+      - feature
+      classification: nonproduction

.github/copilot-instructions.md

@@ -0,0 +1,62 @@
+# Copilot Coding Agent Instructions for `vscode-csharp`
+
+## Project Overview
+- This is the official C# extension for Visual Studio Code, supporting C# development via OmniSharp and Roslyn-based language servers.
+- The codebase is TypeScript/JavaScript, with some JSON and configuration files. It integrates with .NET components and external language servers.
+
+## Architecture & Key Components
+- **src/**: Main extension source. Key subfolders:
+  - `lsptoolshost/`: Hosts LSP (Language Server Protocol) logic, including Copilot integration (`copilot/`), Roslyn, and Razor support.
+  - `omnisharp/`: Protocols and logic for OmniSharp-based language server.
+  - `razor/`: Razor language support and configuration.
+- **Copilot Integration**:
+  - `src/lsptoolshost/copilot/contextProviders.ts` and `relatedFilesProvider.ts` register C# context and related files providers for GitHub Copilot and Copilot Chat extensions.
+  - The Roslyn Copilot language server is managed as a downloadable component (see `package.json` and `CONTRIBUTING.md`).
+
+## Developer Workflows
+- **Build**: `npm run compile` (or use VS Code build task)
+- **Test**: `npm test` (runs Jest tests)
+- **Package**: `npm run package` (creates VSIX)
+- **Dependencies**: Use `gulp installDependencies` to fetch .NET/LS components
+- **Debugging**: See `docs/debugger/` for advanced .NET debugging, including runtime and external library debugging.
+- **Roslyn Copilot Language Server**: To update/test, see instructions in `CONTRIBUTING.md` (triggers pipeline, checks logs for install, etc.)
+
+## Infrastructure Tasks
+- **Tasks Directory**: Build automation is in `tasks/` using Gulp. Key modules:
+  - `testTasks.ts`: Test orchestration for unit/integration tests across components
+  - `offlinePackagingTasks.ts`: VSIX packaging for different platforms (`vsix:release:package:*`)
+  - `componentUpdateTasks.ts`: Automated updates for Roslyn Copilot components
+  - `snapTasks.ts`: Version bumping and changelog management for releases
+  - `gitTasks.ts`: Git operations for automated PR creation and branch management
+- **Adding New Tasks**: Create `.ts` file in `tasks/`, define `gulp.task()` functions, require in `gulpfile.ts`
+- **Task Patterns**: Use `projectPaths.ts` for consistent path references, follow existing naming conventions (`test:integration:*`, `vsix:*`, etc.)
+
+## Project Conventions & Patterns
+- **TypeScript**: Follows strict linting (`.eslintrc.js`), including header/license blocks and camelCase filenames (except for interfaces and special files).
+- **Component Downloads**: Language servers and debuggers are downloaded at runtime; see `package.json` for URLs and install logic.
+- **Copilot Providers**: Use `registerCopilotContextProviders` and `registerCopilotRelatedFilesProvider` to extend Copilot context for C#.
+- **Testing**: Prefer integration tests over unit tests for features. Structure follows:
+  - `test/lsptoolshost/integrationTests/` for Roslyn/LSP features
+  - `test/omnisharp/omnisharpIntegrationTests/` for OmniSharp features  
+  - `test/razor/razorIntegrationTests/` for Razor features
+  - Use `test/*/integrationTests/integrationHelpers.ts` for test setup utilities
+  - Tests use Jest with VS Code test environment and require workspace test assets
+  - Run with `npm run test:integration:*` commands (e.g., `npm run test:integration:csharp`)
+
+## Integration Points
+- **GitHub Copilot**: Extension registers C# context and related files providers if Copilot/Copilot Chat extensions are present.
+- **Roslyn Language Server**: Managed as a downloadable component, versioned in `package.json` and updated via pipeline.
+- **OmniSharp**: Legacy support, also downloaded as a component.
+
+## Examples
+- To add a new Copilot context provider: see `src/lsptoolshost/copilot/contextProviders.ts`.
+- To update Roslyn Copilot server: follow `CONTRIBUTING.md` > "Updating the Roslyn Copilot Language Server version".
+
+## References
+- [README.md](../README.md): User-facing overview and features
+- [CONTRIBUTING.md](../CONTRIBUTING.md): Dev setup, packaging, and advanced workflows
+- [package.json](../package.json): Component download logic, scripts
+- [src/lsptoolshost/copilot/](../src/lsptoolshost/copilot/): Copilot integration logic
+
+---
+For any unclear or incomplete sections, please provide feedback to improve these instructions.

.github/workflows/branch-snap.yml

@@ -12,7 +12,8 @@ jobs:
     with:
       configuration_file_path: '.config/snap-flow.json'
 
-  create-pull-request:
+  bump-main-version:
+    needs: check-script
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
     steps:

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,55 @@
+# GitHub Copilot setup steps for the C# VS Code extension
+# This file configures the environment for the GitHub Copilot coding agent
+
+name: "Copilot Setup Steps"
+
+# Automatically run the setup steps when they are changed to allow for easy validation, and
+# allow manual testing through the repository's "Actions" tab
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read  # Read access to the repository contents (required for checkout)
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      # Install Node.js (required for TypeScript compilation and npm packages)
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      # Install .NET SDK (required for some build components and MSBuild tasks)
+      - uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+
+      # Install npm dependencies
+      - name: Install dependencies
+        run: npm ci
+
+      # Install gulp globally (required for build tasks)
+      - name: Install gulp
+        run: npm install -g gulp
+
+      # Install vsce (needed for packaging tasks)
+      - name: Install vsce
+        run: npm install -g vsce
+
+      # Install server dependencies (needed for integration tests and running)
+      - name: Install dependencies
+        run: gulp installDependencies
+
+      

.github/workflows/create-release.yml

@@ -0,0 +1,18 @@
+name: Create GitHub Release
+on:
+  push:
+    tags:
+      - 'v2.*'
+
+permissions:
+  contents: write
+
+jobs:
+  # This job runs against the yaml defined in the tag we were triggered on.
+  # So we can modify the release creation without having to wait for the change to flow into the commit
+  # that we're tagging, we call a reusable workflow from main
+  create-release:
+    uses: dotnet/vscode-csharp/.github/workflows/release-reusable.yml@main
+    with:
+      tag: ${{ github.ref_name }}
+    secrets: inherit

.github/workflows/release-reusable.yml

@@ -0,0 +1,73 @@
+name: Reusable - Create Release from Changelog
+
+on:
+  workflow_call:
+    inputs:
+      tag:
+        description: Tag name to create a release for (e.g. v2.88.0 or v2.88.0-prerelease)
+        required: true
+        type: string
+
+permissions:
+  contents: write
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tag
+        uses: actions/checkout@v4
+        with:
+          ref: refs/tags/${{ inputs.tag }}
+
+      - name: Create release from CHANGELOG
+        uses: actions/github-script@v7
+        env:
+          TAG: ${{ inputs.tag }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const { readFile } = require('fs/promises');
+
+            const tag = process.env.TAG;
+            core.info(`Creating release for tag: ${tag}`);
+
+            if (!tag || !tag.startsWith('v2.')) {
+              core.setFailed('Invalid tag name. Tag name must start with "v2."');
+              return;
+            }
+
+            // Read CHANGELOG.md and extract the latest section (first single '#' header)
+            const changelog = await readFile('CHANGELOG.md', 'utf8');
+            const headerMatch = changelog.match(/^# .+$/m);
+            if (!headerMatch) {
+              core.setFailed('Could not find a top-level # header in CHANGELOG.md');
+              return;
+            }
+            const startIdx = changelog.indexOf(headerMatch[0]);
+            let endIdx = changelog.indexOf('\n# ', startIdx + headerMatch[0].length);
+            if (endIdx === -1) {
+              endIdx = changelog.length;
+            }
+            const releaseNotes = changelog.substring(startIdx, endIdx).trim();
+
+            const isPrerelease = tag.includes('-prerelease');
+            core.info(`Prerelease: ${isPrerelease}`);
+
+            try {
+              const response = await github.rest.repos.createRelease({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                tag_name: tag,
+                name: tag,
+                body: releaseNotes,
+                prerelease: isPrerelease,
+              });
+              core.info(`Release created: ${response.data.html_url}`);
+            } catch (err) {
+              if (err && err.status === 422 && err.message && String(err.message).includes('already_exists')) {
+                core.warning(`Release for tag '${tag}' already exists.`);
+              } else {
+                core.setFailed(`Error creating release: ${err?.message ?? err}`);
+              }
+            }

.github/workflows/update-changelog.yml

@@ -0,0 +1,36 @@
+name: Update CHANGELOG
+on:
+  workflow_dispatch:
+  schedule:
+    # Runs every Tuesday at 9 PM Pacific Time (5 AM UTC Wednesday)
+    - cron: '0 5 * * 3'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Install roslyn-tools
+        run: dotnet tool install -g Microsoft.RoslynTools --prerelease --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json
+      - name: Install NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - name: Install dependencies
+        run: npm ci
+      - name: Update CHANGELOG
+        run: npx gulp updateChangelog
+      - name: Create update PR
+        uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update ${{ github.ref_name }} CHANGELOG
+          title: '[automated] Update ${{ github.ref_name }} CHANGELOG'
+          branch: merge/update-${{ github.ref_name }}-changelog

.mocharc.jsonc

@@ -12,7 +12,8 @@
         "vsix/": true
     },
     "[typescript]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
     },
     "csharp.suppressDotnetRestoreNotification": true,
     "typescript.tsdk": "./node_modules/typescript/lib",