[docs] Update documentation for features from 2026-05-19#1409
Open
danielmeppiel wants to merge 1 commit into
Open
[docs] Update documentation for features from 2026-05-19#1409danielmeppiel wants to merge 1 commit into
danielmeppiel wants to merge 1 commit into
Conversation
- installation.md: add troubleshooting section for Windows Defender / antivirus flagging apm.exe (HRESULTs 0x800700E1 and 0x800704EC). Covers three remediation options: Defender exclusion path, pip install, and false-positive submission. Clearly distinguishes this from the AppLocker/WDAC Access is denied block (0x80070005). - private-and-org-packages.md: add 'Custom SSH user' subsection documenting the ability to specify a non-default SSH user in ssh:// dependency URLs (e.g. EMU accounts like meppiel-microsoft). Notes the ADO exception (always uses literal git user). Triggered by merged PRs: - #1408 fix(install): detect Windows Defender AV block and emit guidance - #1385 fix(deps): honor SSH user from dependency URL Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
danielmeppiel
added
automation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Starlight documentation to reflect two recently shipped user-facing behaviors: Windows antivirus block detection guidance during install/self-update, and support for custom SSH users in dependency URLs.
Changes:
- Add a new Windows troubleshooting section for Defender/AV blocks of
apm.exe, including remediation options and HRESULT distinctions. - Document how to specify a non-default SSH user in
ssh://dependency URLs, including validation rules and the Azure DevOps exception.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/getting-started/installation.md | Adds troubleshooting guidance for Windows Defender/antivirus blocks during the Testing binary... step. |
| docs/src/content/docs/consumer/private-and-org-packages.md | Documents custom SSH user support in dependency URLs (and notes the ADO git-user exception). |
Copilot's findings
- Files reviewed: 2/2 changed files
- Comments generated: 2
Comment on lines
+264
to
+273
| Windows Defender (or another real-time antivirus) is blocking the unsigned PyInstaller binary. HRESULT `0x800700E1` and `0x800704EC` both indicate this class of block. | ||
|
|
||
| **Option 1 -- Add a Defender exclusion (elevated PowerShell):** | ||
|
|
||
| ```powershell | ||
| # Run as administrator | ||
| Add-MpPreference -ExclusionPath "$env:LOCALAPPDATA\Programs\apm" | ||
| ``` | ||
|
|
||
| This tells Defender to skip scanning files under the APM install root. Re-run the installer after adding the exclusion. |
Comment on lines
+151
to
+166
| By default APM clones over SSH as `git`. To authenticate as a different | ||
| SSH identity -- for example, an EMU account or a custom service | ||
| account -- include the user directly in the `ssh://` URL: | ||
|
|
||
| ```yaml | ||
| dependencies: | ||
| apm: | ||
| - git: ssh://meppiel-microsoft@github.com/acme/standards.git | ||
| ref: v1.2.0 | ||
| - git: ssh://svc-account@bitbucket.acme.internal:7999/team/libs.git | ||
| ref: v1.2.0 | ||
| ``` | ||
|
|
||
| The user portion is validated against a strict allowlist | ||
| (`[a-zA-Z0-9_][a-zA-Z0-9_.+-]*`, max 64 characters) before the SSH URL | ||
| is composed. Leading dashes and percent-encoded userinfo are rejected. |
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.
Documentation Updates - 2026-05-19
This PR updates the documentation based on user-facing features merged in the last 24 hours.
Features Documented
Changes Made
Updated
docs/src/content/docs/getting-started/installation.mdto add a new troubleshootingsection for when Windows Defender (or another AV) flags
apm.exeas potentially unwantedsoftware (HRESULTs
0x800700E1/0x800704EC). Covers three remediation paths andclarifies the distinction from the AppLocker/WDAC
Access is deniedblock.Updated
docs/src/content/docs/consumer/private-and-org-packages.mdto add a "Custom SSH user"subsection under the custom ports section, documenting that users can now specify a non-default
SSH identity (e.g. EMU accounts like
meppiel-microsoft) directly in(redacted) dependency URLs. Notes the ADO exception wheregit` is always used.Merged PRs Referenced
Notes