Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/actions/build-vsix/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ runs:
run: python -m pip install -U pip pipx wheel
shell: bash

- name: Install Node dependencies through Microsoft feeds
run: npm run ci:msft
- name: Install Node dependencies
run: npm ci
env:
npm_config_prefer_offline: 'true'
shell: bash
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/lint/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ runs:
shell: bash

- name: Install Node dependencies
run: npm run ci:msft
run: npm ci
shell: bash

- name: Lint TypeScript code
Expand Down
4 changes: 0 additions & 4 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ on:
schedule:
- cron: '15 16 * * 2'

env:
NPM_CONFIG_REGISTRY: https://packagefeedproxy.microsoft.io/npm/
PIP_INDEX_URL: https://packagefeedproxy.microsoft.io/pypi/simple/

jobs:
analyze:
name: Analyze
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/info-needed-closer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ permissions:
jobs:
main:
runs-on: ubuntu-latest
permissions:
contents: read
issues: write
steps:
- name: Checkout Actions
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/issue-labels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ jobs:
add-classify-label:
name: "Add 'triage-needed' and remove assignees"
runs-on: ubuntu-latest
permissions:
contents: read
issues: write
steps:
- name: Checkout Actions
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/localization.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ jobs:
with:
app-id: ${{ vars.PYTHON_LOCALIZATION_APP_ID }}
private-key: ${{ secrets.PYTHON_LOCALIZATION_PRIVATE_KEY }}
npm-registry: https://registry.npmjs.org/
9 changes: 7 additions & 2 deletions .github/workflows/pr-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
permissions: {}

env:
PIP_INDEX_URL: https://packagefeedproxy.microsoft.io/pypi/simple/
NODE_VERSION: 22.17.0
TEST_RESULTS_DIRECTORY: .
# Force a path with spaces and unicode chars to test extension works in these scenarios
Expand All @@ -17,6 +16,8 @@ jobs:
build-vsix:
name: Create VSIX
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
Expand All @@ -31,6 +32,8 @@ jobs:
lint:
name: Lint
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
Expand All @@ -45,6 +48,8 @@ jobs:
tests:
name: Tests
runs-on: ${{ matrix.os }}
permissions:
contents: read
defaults:
run:
working-directory: ${{ env.special-working-directory }}
Expand Down Expand Up @@ -85,7 +90,7 @@ jobs:
cache-dependency-path: ${{ env.special-working-directory-relative }}/package-lock.json

- name: Install dependencies (npm ci)
run: npm run ci:msft
run: npm ci

# Now that the bundle is installed to target using python 3.9
# switch back the python we want to test with
Expand Down
9 changes: 7 additions & 2 deletions .github/workflows/push-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ on:
permissions: {}

env:
PIP_INDEX_URL: https://packagefeedproxy.microsoft.io/pypi/simple/
NODE_VERSION: 22.17.0
TEST_RESULTS_DIRECTORY: .
# Force a path with spaces and unicode chars to test extension works in these scenarios
Expand All @@ -22,6 +21,8 @@ jobs:
build-vsix:
name: Create VSIX
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
Expand All @@ -36,6 +37,8 @@ jobs:
lint:
name: Lint
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
Expand All @@ -50,6 +53,8 @@ jobs:
tests:
name: Tests
runs-on: ${{ matrix.os }}
permissions:
contents: read
defaults:
run:
working-directory: ${{ env.special-working-directory }}
Expand Down Expand Up @@ -90,7 +95,7 @@ jobs:
cache-dependency-path: ${{ env.special-working-directory-relative }}/package-lock.json

- name: Install dependencies (npm ci)
run: npm run ci:msft
run: npm ci

# Now that the bundle is installed to target using python 3.9
# switch back the python we want to test with
Expand Down
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The Debugpy Extension for Visual Studio Code collects usage data and sends it to

### Local package feeds

Use Node.js supported by this repository and Python 3.10 or later. Both setup commands create or reuse `.venv` and install the Python bundling tools. Choose the appropriate setup below before installing dependencies. Committed lockfiles use public npm URLs; Microsoft setup rewrites working copies for proxy installs.
Use Node.js supported by this repository and Python 3.10 or later. Both setup commands create or reuse `.venv` and install the Python bundling tools. Choose the appropriate setup below before installing dependencies. Committed lockfiles use public npm URLs; Microsoft setup rewrites working copies for Microsoft feed installs.

#### Public contributors (non-Microsoft employees)

Expand All @@ -75,13 +75,13 @@ For subsequent npm installs, use `npm ci`. Public contributors do not need the M

> **Microsoft users only:** The commands in this section configure Microsoft package feeds. Public contributors should use the public setup above.

Use the Microsoft setup, which selects `https://packagefeedproxy.microsoft.io/npm/` and `https://packagefeedproxy.microsoft.io/pypi/simple/` for its child processes:
Use the Microsoft setup, which selects the `Pylance_PublicPackages` npm and PyPI feeds in `build/package-feeds.json`. Configure credentials for both feeds before running it; setup does not authenticate:

```bash
npm run setup:msft
```

Microsoft setup rewrites public npm and Yarn `resolved` URLs in the root `package-lock.json` to the npm proxy before running `npm ci`. Versions, integrity hashes, formatting, and private-feed URLs are preserved. The public setup leaves lockfiles unchanged.
Microsoft setup rewrites public npm and Yarn `resolved` URLs in the root `package-lock.json` to the Microsoft npm feed before running `npm ci`. Versions, integrity hashes, formatting, and private-feed URLs are preserved. The public setup leaves lockfiles unchanged.

After pulling a new lockfile from GitHub, rerun `npm run setup:msft`, or run the dependency-free rewrite step alone before your next install/build:

Expand All @@ -97,7 +97,7 @@ For subsequent root npm installs, use:
npm run ci:msft
```

This rewrites the root lockfile, then runs root `npm ci` with the proxy registry explicitly selected for package, audit, and metadata requests. Use `npm run setup:msft` for full setup, including Python dependencies.
This rewrites the root lockfile, then runs root `npm ci` with the Microsoft registry explicitly selected for package, audit, and metadata requests. Use `npm run setup:msft` for full setup, including Python dependencies.

Local setup, lockfile rewriting, and `ci:msft` share the feed URLs in `build/package-feeds.json`.

Expand All @@ -121,25 +121,19 @@ To normalize manually, run `npm run normalize-lockfile`, review the changes, and

### GitHub Actions package feeds

The PR and push workflows set `PIP_INDEX_URL` to `https://packagefeedproxy.microsoft.io/pypi/simple/` for pip and nox installs. Their Node installation steps select `https://packagefeedproxy.microsoft.io/npm/` explicitly through `npm run ci:msft`, so these workflows do not set `NPM_CONFIG_REGISTRY`. CodeQL retains both environment variables because its autobuild step does not use the install helper. The npm endpoint follows the [TypeScript CI package-feed-proxy job](https://github.com/microsoft/TypeScript/blob/main/.github/workflows/ci.yml).

The shared lint and VSIX build actions and applicable PR/push test jobs use `npm run ci:msft`, rewriting working-copy lockfile URLs before installation and explicitly selecting the proxy for npm requests. Workflows do not commit these rewrites or change local registry configuration or Dependabot configuration. Existing dependency caches are retained; the VSIX build also retains its offline-cache preference. CodeQL retains workflow-level feed settings for its autobuild step.
GitHub Actions use public npm and PyPI without feed authentication, including for fork PRs. Localization explicitly selects public npm because the shared action defaults to a proxy.

### Azure release package feeds

The DevDiv Azure stable/prerelease pipelines pass the npm proxy to their build/publish templates using `customNPMRegistry`. Their dependency install steps use `npm run ci:msft` to rewrite the root npm lockfile and install through the proxy.

Each Python bootstrap and bundled-library install step explicitly sets `PIP_INDEX_URL` from `PIP_PROXY_INDEX_URL`, selecting the pip proxy even when a template's authentication setup changes the job-level index. Release triggers, approval gates, signing, and publishing behavior are unchanged.

Dependabot continues to use public registries and its existing update settings. Legacy Azure stable, prerelease, and validation definitions are unchanged.
The DevDiv stable and prerelease pipelines pass the `Pylance_PublicPackages` npm feed to the shared template, which authenticates npm and the `DevDiv/debugpy` Python feed before build steps. Release triggers, approval gates, signing, and publishing are unchanged.

### Localization

The **Localization** GitHub workflow submits English strings using the [shared composite action and Python tooling](https://github.com/microsoft/vscode-python-ci/tree/main/actions/localization). Stable and pre-release DevDiv pipelines independently retrieve translations through Pylance-Eng's `pullLocalization: true`; releases never submit English or create translation-update PRs.

Both paths use `microsoft/vscode-python-extensions-loc`, branch **`dev`**, with canonical extension ID **`ms-python.debugpy`**. English XLF is stored in `src/en/ms-python.debugpy` and handbacks in `out/ms-python.debugpy`. The action and Azure tooling checkout are pinned to the same reviewed revision.

Configure the `PYTHON_LOCALIZATION_APP_ID` Actions variable and `PYTHON_LOCALIZATION_PRIVATE_KEY` secret here, or grant access to organization-level credentials. The app needs Contents write access only to the localization drop; the caller's repository token stays read-only. The shared action uses the Microsoft npm proxy and pinned localization CLI. Authorize the literal `Github-Pylance` service connection for the [pipeline templates](https://github.com/microsoft/pylance-eng), translation, and shared-tooling repository resources in both release pipelines.
Configure the `PYTHON_LOCALIZATION_APP_ID` Actions variable and `PYTHON_LOCALIZATION_PRIVATE_KEY` secret here, or grant access to organization-level credentials. The app needs Contents write access only to the localization drop; the caller's repository token stays read-only. The shared action uses public npm and a pinned localization CLI. Authorize the literal `Github-Pylance` service connection for the [pipeline templates](https://github.com/microsoft/pylance-eng), translation, and shared-tooling repository resources in both release pipelines.

Keep English `package.nls.json` tracked. Root `package.nls.<locale>.json` and `l10n/` runtime files are generated, git-ignored release outputs. VSCE must include generated locale files despite Git ignores. Local builds are English-only unless translations are imported explicitly (debugger pre-built assets remain available, but the release import runs after their overlay and is authoritative).

Expand Down
18 changes: 4 additions & 14 deletions build/azure-devdiv-pipeline.pre-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,8 @@ variables:
value: VSCode-python-debugger
- name: VsixName
value: python-debugger.vsix
- name: NPM_CONFIG_REGISTRY
value: 'https://packagefeedproxy.microsoft.io/npm/'
- name: PIP_PROXY_INDEX_URL
value: 'https://packagefeedproxy.microsoft.io/pypi/simple/'
- name: AZURE_ARTIFACTS_FEED
value: 'https://devdiv.pkgs.visualstudio.com/DevDiv/_packaging/Pylance_PublicPackages/npm/registry/'

parameters:
- name: publishExtension
Expand Down Expand Up @@ -74,28 +72,20 @@ parameters:
- name: buildSteps
type: stepList
default:
- script: npm run ci:msft
- script: npm ci
displayName: Install NPM dependencies

- script: python -m pip install -U pip
displayName: Upgrade pip
env:
PIP_INDEX_URL: $(PIP_PROXY_INDEX_URL)

- script: python -m pip install wheel
displayName: Install wheel
env:
PIP_INDEX_URL: $(PIP_PROXY_INDEX_URL)

- script: python -m pip install nox
displayName: Install nox
env:
PIP_INDEX_URL: $(PIP_PROXY_INDEX_URL)

- script: python -m nox --session install_bundled_libs
displayName: Install Python dependencies
env:
PIP_INDEX_URL: $(PIP_PROXY_INDEX_URL)

- script: python ./build/update_ext_version.py --for-publishing
displayName: Update build number
Expand All @@ -112,7 +102,7 @@ extends:
buildPlatforms: ${{ parameters.buildPlatforms }}
buildSteps: ${{ parameters.buildSteps }}
standardizedVersioning: true
customNPMRegistry: $(NPM_CONFIG_REGISTRY)
customNPMRegistry: $(AZURE_ARTIFACTS_FEED)
publishExtension: ${{ parameters.publishExtension }}
teamName: $(TeamName)
ghCreateTag: true
Expand Down
18 changes: 4 additions & 14 deletions build/azure-devdiv-pipeline.stable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,8 @@ variables:
value: VSCode-python-debugger
- name: VsixName
value: python-debugger.vsix
- name: NPM_CONFIG_REGISTRY
value: 'https://packagefeedproxy.microsoft.io/npm/'
- name: PIP_PROXY_INDEX_URL
value: 'https://packagefeedproxy.microsoft.io/pypi/simple/'
- name: AZURE_ARTIFACTS_FEED
value: 'https://devdiv.pkgs.visualstudio.com/DevDiv/_packaging/Pylance_PublicPackages/npm/registry/'

parameters:
- name: publishExtension
Expand Down Expand Up @@ -69,28 +67,20 @@ parameters:
- name: buildSteps
type: stepList
default:
- script: npm run ci:msft
- script: npm ci
displayName: Install NPM dependencies

- script: python -m pip install -U pip
displayName: Upgrade pip
env:
PIP_INDEX_URL: $(PIP_PROXY_INDEX_URL)

- script: python -m pip install wheel
displayName: Install wheel
env:
PIP_INDEX_URL: $(PIP_PROXY_INDEX_URL)

- script: python -m pip install nox
displayName: Install nox
env:
PIP_INDEX_URL: $(PIP_PROXY_INDEX_URL)

- script: python -m nox --session install_bundled_libs
displayName: Install Python dependencies
env:
PIP_INDEX_URL: $(PIP_PROXY_INDEX_URL)

- script: python ./build/update_ext_version.py --release --for-publishing
displayName: Update build number
Expand All @@ -107,7 +97,7 @@ extends:
buildPlatforms: ${{ parameters.buildPlatforms }}
buildSteps: ${{ parameters.buildSteps }}
standardizedVersioning: true
customNPMRegistry: $(NPM_CONFIG_REGISTRY)
customNPMRegistry: $(AZURE_ARTIFACTS_FEED)
publishExtension: ${{ parameters.publishExtension }}
teamName: $(TeamName)
ghCreateTag: true
Expand Down
4 changes: 2 additions & 2 deletions build/package-feeds.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"pip": "https://pypi.org/simple/"
},
"microsoft": {
"npm": "https://packagefeedproxy.microsoft.io/npm/",
"pip": "https://packagefeedproxy.microsoft.io/pypi/simple/"
"npm": "https://devdiv.pkgs.visualstudio.com/DevDiv/_packaging/Pylance_PublicPackages/npm/registry/",
"pip": "https://pkgs.dev.azure.com/devdiv/DevDiv/_packaging/Pylance_PublicPackages/pypi/simple/"
}
}
27 changes: 17 additions & 10 deletions build/setup-npm-registry.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ const { readFileSync, writeFileSync } = require('node:fs');
const path = require('node:path');
const { microsoft } = require('./package-feeds.json');

function rewritePackageLock(source) {
function normalizeRegistry(registry) {
return registry.endsWith('/') ? registry : `${registry}/`;
}

function rewritePackageLock(source, registry = microsoft.npm) {
const lockfile = JSON.parse(source);
if (
![2, 3].includes(lockfile.lockfileVersion) ||
Expand All @@ -17,18 +21,19 @@ function rewritePackageLock(source) {
throw new Error('Expected an npm lockfile with lockfileVersion 2 or 3 and a packages section.');
}

const normalizedRegistry = normalizeRegistry(registry);
return source.replace(/("resolved"\s*:\s*)("(?:\\.|[^"\\])*")/g, (match, prefix, encodedUrl) => {
const url = JSON.parse(encodedUrl);
const rewritten = url.replace(/^https:\/\/registry\.(?:npmjs\.org|yarnpkg\.com)\//, microsoft.npm);
const rewritten = url.replace(/^https:\/\/registry\.(?:npmjs\.org|yarnpkg\.com)\//, normalizedRegistry);
return rewritten === url ? match : prefix + JSON.stringify(rewritten);
});
}

function rewritePackageLocks(root = path.resolve(__dirname, '..')) {
function rewritePackageLocks(root = path.resolve(__dirname, '..'), registry = microsoft.npm) {
const files = [path.join(root, 'package-lock.json')];
const updates = files.map((file) => {
const source = readFileSync(file, 'utf8');
return { file, source, rewritten: rewritePackageLock(source) };
return { file, source, rewritten: rewritePackageLock(source, registry) };
});
for (const { file, source, rewritten } of updates) {
if (rewritten !== source) {
Expand All @@ -48,13 +53,15 @@ if (require.main === module) {
if (install && !process.env.npm_execpath) {
throw new Error('Run npm install using npm run ci:msft.');
}
rewritePackageLocks();
const registry = normalizeRegistry(
process.env.npm_config_registry || process.env.NPM_CONFIG_REGISTRY || microsoft.npm,
);
rewritePackageLocks(undefined, registry);
if (install) {
const result = spawnSync(
process.execPath,
[process.env.npm_execpath, 'ci', `--registry=${microsoft.npm}`],
{ cwd: path.resolve(__dirname, '..'), stdio: 'inherit' },
);
const result = spawnSync(process.execPath, [process.env.npm_execpath, 'ci', `--registry=${registry}`], {
cwd: path.resolve(__dirname, '..'),
stdio: 'inherit',
});
if (result.error || result.signal || result.status !== 0) {
const reason = result.error?.message || result.signal || `exit code ${result.status}`;
const error = new Error(`npm ci failed: ${reason}`);
Expand Down
Loading
Loading