Skip to content

docs(devcontainer): stop advertising the unpublished GHCR feature - #3526

Merged
Daniel Meppiel (danielmeppiel) merged 1 commit into
mainfrom
danielmeppiel-lane-b-portfolio-policy
Nov 10, 2026
Merged

Daniel Meppiel (danielmeppiel) merged 1 commit into
mainfrom
danielmeppiel-lane-b-portfolio-policy

Conversation

@danielmeppiel

Copy link
Copy Markdown
Collaborator

Description

TL;DR

devcontainer/README.md told users to add ghcr.io/microsoft/apm/apm-cli:1 and 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)

  • Section 4 "Quick start -- add the published feature" tells users to add "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.
  • The "Tag selection" table advertises :1, :1.0, :1.0.0 and :latest, but the publish workflow never ran on push: its trigger is commented out in devcontainer-feature-publish.yml#L39-L45.
  • [!] The overview reads as if the feature is discoverable through the Dev Container Features ecosystem, which it is not.

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)

# Fix
1 Replace the four published-feature subsections of section 4 (quick start, pin, combine, tag table) with one [!IMPORTANT] not-published notice.
2 List the supported routes: installer in postCreateCommand, pip install apm-cli with the official Python feature, and the community-maintained ghcr.io/postfinance/devcontainer-features/apm (marked as maintained outside this project).
3 Add a one-line [!NOTE] under the title pointing to section 4, so readers landing on the overview see the status first.

Implementation (HOW)

Trade-offs

  • Fix the README now; leave the source and workflows. Chose a docs-only correction; deferred deleting 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).
  • Point to a community feature. It is the closest thing to what the README used to promise; the notice says it is maintained outside this project so it is not read as an endorsement or support commitment.
  • Scenario Evidence skipped: docs-only PR (skip case in assets/scenario-evidence-rubric.md); no behavior change, no tests affected.

Benefits

  1. Zero references to the nonexistent ghcr.io/microsoft/apm/apm-cli tags in user-facing instructions (4 tags and 3 JSON snippets removed).
  2. Readers get three working routes instead of a failing feature reference.
  3. The README matches the 2026-11-10 decision on Devcontainer feature not published #1273.

Validation

GHCR check (anonymous pull, 2026-11-10)
tag 1: HTTP 403            # ghcr.io/microsoft/apm/apm-cli:1
tag latest: HTTP 403       # ghcr.io/microsoft/apm/apm-cli:latest
postfinance apm:1 HTTP 200 # ghcr.io/postfinance/devcontainer-features/apm:latest
$ grep -n "ghcr.io/microsoft/apm/apm-cli" devcontainer/README.md
92:> This feature is **not published**. `ghcr.io/microsoft/apm/apm-cli` does not
$ uv run --extra dev ruff check src/ tests/ -q && uv run --extra dev ruff format --check src/ tests/ -q && echo LINT_OK
LINT_OK

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

  • Open devcontainer/README.md on this branch: the title note links to section 4, which shows the not-published notice.
  • Search the file for apm-cli:1: no install instruction remains.
  • Follow route 2 (ghcr.io/devcontainers/features/python:1 + pip install apm-cli) in any dev container: apm --version works.

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

  • Bug fix
  • New feature
  • Documentation
  • Maintenance / refactor

Testing

  • Tested locally
  • All existing tests pass
  • Added tests for new functionality (if applicable)

Spec conformance (OpenAPM v0.1)

If this PR changes behaviour that an OpenAPM v0.1 req-XXX covers,
confirm the three-step ritual in the
development guide:

  • Spec edit: docs/src/content/docs/specs/openapm-v0.1.md updated
    (new/changed <a id="req-XXX"></a> anchor + prose + Appendix C
    row).
  • Manifest edit: docs/src/content/docs/specs/manifests/openapm-v0.1.requirements.yml
    updated.
  • Test edit: a @pytest.mark.req("req-XXX") test under
    tests/spec_conformance/ added or extended.
  • CONFORMANCE.{md,json} regenerated via
    uv run --extra dev python -m tests.spec_conformance.gen_statement
    and committed.
  • N/A -- this PR does not change OpenAPM-observable behaviour.

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

The README told users to add ghcr.io/microsoft/apm/apm-cli:1 and listed
tags that were never published. Replace the quick start, pin and tag
sections with a not-published notice and the supported routes.

Refs #1273, #3520

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 10, 2026 16:02

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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 thread devcontainer/README.md
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
@danielmeppiel
Daniel Meppiel (danielmeppiel) merged commit 9866edf into main Nov 10, 2026
32 checks passed
@danielmeppiel
Daniel Meppiel (danielmeppiel) deleted the danielmeppiel-lane-b-portfolio-policy branch November 10, 2026 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants