Repository navigation
docs(devcontainer): stop advertising the unpublished GHCR feature - #3526
Merged
Daniel Meppiel (danielmeppiel) merged 1 commit intoNov 10, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The replacement README command still fails when postCreateCommand runs as root; it needs a non-root caveat and a root-container variant using --prefix /usr/local.
1 open issue
What changed in this PR
This docs-only PR stops advertising the unpublished official Dev Container Feature and points readers to alternative installation routes. Feature source and workflow cleanup remain deferred to #3520.
Changes:
- Adds a prominent notice that the official feature is not published.
- Replaces published-feature examples and tag listings with installer, Python/PyPI, and community-feature alternatives.
- Preserves local development instructions and existing feature documentation.
| File | Description |
|---|---|
devcontainer/README.md |
Removes unavailable feature installation instructions and documents alternatives, including compatibility and community-maintenance caveats. |
Review effort: Balanced
Comment on lines
+97
to
+98
| > - `postCreateCommand`: `curl -sSL https://aka.ms/apm-unix | sh` (prebuilt | ||
| > Linux binaries currently need glibc 2.38+; see [#3399](https://github.com/microsoft/apm/issues/3399)), or |
Daniel Meppiel (danielmeppiel)
deleted the
danielmeppiel-lane-b-portfolio-policy
branch
November 10, 2026 18:12
This was referenced Nov 11, 2026
Merged
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.

Description
TL;DR
devcontainer/README.mdtold users to addghcr.io/microsoft/apm/apm-cli:1and listed four tags, none of which were ever published. This replaces those sections with a not-published notice and the supported ways to run APM in a dev container. It is a one-file docs correction; the feature source and workflows are untouched (their removal is #3520).Note
#1273 (official Dev Container Feature) was closed as not planned on 2026-11-10 under the distribution-channel policy; this PR only stops the README from promising an artifact that does not exist.
Problem (WHY)
"ghcr.io/microsoft/apm/apm-cli:1": {}. An anonymous pull of that reference is refused (HTTP 403, see Validation), so a user following the README gets a container build failure.:1,:1.0,:1.0.0and:latest, but the publish workflow never ran on push: its trigger is commented out indevcontainer-feature-publish.yml#L39-L45.Why it matters: docs that point at a nonexistent artifact cost every reader a failed build. The advertised references are dead links in practice, and CONTRIBUTING.md "Small corrections" says: "Typo fixes and broken documentation links have standing preapproval."
Approach (WHAT)
[!IMPORTANT]not-published notice.postCreateCommand,pip install apm-cliwith the official Python feature, and the community-maintainedghcr.io/postfinance/devcontainer-features/apm(marked as maintained outside this project).[!NOTE]under the title pointing to section 4, so readers landing on the overview see the status first.Implementation (HOW)
devcontainer/README.md— the only file changed (+14 / −51). Sections 1-3 (what the feature is and how it installs) and 5-7 (tests, environments) are kept, because the source still lives in the repo until [FEATURE] Retire the unpublished Dev Container Feature (or reduce it to an install.sh recipe) #3520 decides whether it is removed or reduced to a recipe. "Local development -- test an unpublished build" is kept as is; it stays accurate.Trade-offs
devcontainer/and its two workflows to [FEATURE] Retire the unpublished Dev Container Feature (or reduce it to an install.sh recipe) #3520, which needs its own decision (remove vs. reduce to a recipe).assets/scenario-evidence-rubric.md); no behavior change, no tests affected.Benefits
ghcr.io/microsoft/apm/apm-clitags in user-facing instructions (4 tags and 3 JSON snippets removed).Validation
GHCR check (anonymous pull, 2026-11-10)
The file is printable ASCII (
LC_ALL=C grep -c '[^ -~]'returns 0). No Python, tests or workflows changed, so the test suite was not run.How to test
devcontainer/README.mdon this branch: the title note links to section 4, which shows the not-published notice.apm-cli:1: no install instruction remains.ghcr.io/devcontainers/features/python:1+pip install apm-cli) in any dev container:apm --versionworks.Issue and approved scope
Issue: Refs #1273, #3520
Human scope-approval comment: standing-preapproval case claimed, broken-link (CONTRIBUTING.md "Small corrections"). The README advertised image references that do not exist. Human review decides whether this qualifies. Context: #1273 was closed as not planned on 2026-11-10 by maintainer decision, and #3520 was filed from that decision.
Does this PR complete the issue, or what remains? It does not complete #3520: removing
devcontainer/and its two workflows (or reducing them to a recipe) remains there. #1273 is already closed.Type of change
Testing
Spec conformance (OpenAPM v0.1)
If this PR changes behaviour that an OpenAPM v0.1
req-XXXcovers,confirm the three-step ritual in the
development guide:
docs/src/content/docs/specs/openapm-v0.1.mdupdated(new/changed
<a id="req-XXX"></a>anchor + prose + Appendix Crow).
docs/src/content/docs/specs/manifests/openapm-v0.1.requirements.ymlupdated.
@pytest.mark.req("req-XXX")test undertests/spec_conformance/added or extended.CONFORMANCE.{md,json}regenerated viauv run --extra dev python -m tests.spec_conformance.gen_statementand committed.
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com