Repository navigation
chore(devcontainer): retire the unpublished Dev Container Feature - #3642
Daniel Meppiel (danielmeppiel) merged 4 commits into
Conversation
Remove devcontainer/ (feature sources, bats tests and submodules), the publish and nightly test workflows, and .gitmodules. The feature was never published to GHCR and an official feature was declined in #1273. Add a Dev containers section to the installation guide with the installer and pip recipes and a pointer to the community feature maintained outside this project. Add a regression guard against the stale GHCR reference, feature workflows and the loss of the docs recipe. Fixes #3520 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…devcontainer-feature-3520
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟡 Changes recommended
The documented command fails for containers whose lifecycle user is root, so the guide needs to state the non-root prerequisite and provide a root-compatible variant with an explicit prefix.
1 open issue
What changed in this PR
Retires APM's unpublished Dev Container Feature, completing the cleanup after #3526 removed its misleading installation claims. Dev container users are directed to existing installation channels instead.
Changes:
- Removes feature sources, tests, submodule configuration, and publishing/testing workflows.
- Adds installer and pip recipes plus a clearly identified community-maintained alternative.
- Adds retirement regression guards and a changelog entry.
| File | Description |
|---|---|
tests/unit/test_devcontainer_feature_retired.py |
Adds guards against retired references, sources, and workflows. |
docs/src/content/docs/getting-started/installation.md |
Adds dev container installation guidance. |
devcontainer/test/apm-cli/with-python-feature.sh |
Removes Python-feature compatibility checks. |
devcontainer/test/apm-cli/unit/install.bats |
Removes feature installer unit tests. |
devcontainer/test/apm-cli/test.sh |
Removes the default feature test runner. |
devcontainer/test/apm-cli/scenarios.json |
Removes the feature test matrix. |
devcontainer/test/apm-cli/pinned-version.sh |
Removes pinned-version checks. |
devcontainer/test/apm-cli/generic-checks.sh |
Removes shared feature checks. |
devcontainer/test/apm-cli/default-ubuntu-24.sh |
Removes Ubuntu scenario checks. |
devcontainer/test/apm-cli/default-fedora.sh |
Removes Fedora scenario checks. |
devcontainer/test/apm-cli/default-debian-12.sh |
Removes Debian scenario checks. |
devcontainer/test/apm-cli/default-alpine-3.sh |
Removes Alpine scenario checks. |
devcontainer/src/apm-cli/install.sh |
Removes the feature-specific installer. |
devcontainer/src/apm-cli/devcontainer-feature.json |
Removes the feature manifest. |
devcontainer/scripts/sync-local-devcontainer.sh |
Removes the local feature setup helper. |
devcontainer/README.md |
Removes obsolete feature documentation. |
CHANGELOG.md |
Records the retirement and replacement guidance. |
.gitmodules |
Removes Bats submodule declarations. |
.github/workflows/devcontainer-feature-test.yml |
Removes feature testing automation. |
.github/workflows/devcontainer-feature-publish.yml |
Removes unpublished feature publishing automation. |
Review effort: Balanced
postCreateCommand runs without a terminal, so install.sh skips shell profile edits and apm in ~/.local/bin may be off PATH; root containers fail closed without an explicit destination. Addresses doc-writer panel findings on PR #3642. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
APM Review Panel:
|
| Persona | B | R | N | Takeaway |
|---|---|---|---|---|
| Doc Writer | 0 | 2 | 0 | The section is accurate, short and well placed, and the CHANGELOG entry is correct. Root containers and PATH needed one line each (folded). |
B = blocking-severity findings, R = recommended, N = nits.
Counts are signal strength, not gates. The maintainer ships.
Recommendation
All doc-writer findings were folded in-PR, no recommended items remain open, regression guards are mutation-tested, and the change follows the ratified distribution-channel decision. Merge when CI is green and the requested CODEOWNERS review from Sergio Sisternes (@sergio-sisternes-epam) lands.
Full per-persona findings
Doc Writer
- [recommended] The postCreateCommand installer recipe fails closed in dev containers that run as root. at
docs/src/content/docs/getting-started/installation.md
install.sh refuses root installs without explicit destinations. Folded in 923dd0d: the section now showssh -s -- --prefix /usr/localfor root containers. - [recommended] A non-root installer run in postCreateCommand may put apm in ~/.local/bin without adding it to PATH. at
docs/src/content/docs/getting-started/installation.md
install.sh skips shell profile edits without a controlling terminal. Folded in 923dd0d: the section tells users to add ~/.local/bin to PATH, for example with remoteEnv.
This panel is advisory. It does not block merge. Re-apply the
panel-review label after addressing feedback to re-run.
Generated by autopilot-pr-review-worker. This comment is AI-generated and may contain errors.
Refresh microsoft#2627 against current main; CHANGELOG Fixed entries from both sides kept (microsoft#2627 entry plus main's microsoft#3637 entry and microsoft#3642 Removed section). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Description
TL;DR
Retires the never-published Dev Container Feature: deletes
devcontainer/(feature sources, bats tests, three bats submodules),.gitmodules, and bothdevcontainer-feature-*workflows. The installation guide gains a short Dev containers section with the installer and pip recipes and a pointer to the community feature. A regression guard keeps the stale GHCR reference and feature workflows from coming back.Note
#3526 already removed the README claim. This PR delivers the remaining Done-when items of the approved scope record. Local preflight skipped by maintainer instruction (2026-11-12); CI is the gate.
Problem (WHY)
devcontainer/(merged in Devcontainer feature #861) and.github/workflows/devcontainer-feature-publish.ymlremained onmain, although the publish trigger was commented out and nothing was ever published toghcr.io..github/workflows/devcontainer-feature-test.ymlstill ran a nightly matrix for an artifact the project decided not to ship (Devcontainer feature not published #1273 closed as not planned).Why: the 2026-11-10 distribution-channel decision lists the official channels as install.sh, install.ps1, GitHub release binaries, PyPI, WinGet and Homebrew core, and declines the devcontainer feature (#1273). Dead feature code and its nightly CI contradict that decision.
Approach (WHAT)
devcontainer/and its bats submodules; delete.gitmodules(it only held those three submodules).devcontainer-feature-publish.ymlanddevcontainer-feature-test.yml.## Dev containerstogetting-started/installation.md:postCreateCommandwith the standalone installer, or the official Python feature pluspip install apm-cli; community feature marked as maintained outside this project.tests/unit/test_devcontainer_feature_retired.pyguard.### Removedentry.Implementation (HOW)
devcontainer/**,.gitmodules-- pure deletion (17 tracked paths incl. 3 gitlinks). No other file referenced them (git grep -i devcontainer/batsclean outside CHANGELOG history and unrelated "devcontainers" wording in auth docs)..github/workflows/devcontainer-feature-*.yml-- deleted.merge-gate.ymlEXPECTED_CHECKSnever listed them, so thegateaggregator is unaffected.docs/src/content/docs/getting-started/installation.md-- new section afterpip install; links to existing anchors, restates the glibc 2.28 floor for prebuilt Linux binaries.tests/unit/test_devcontainer_feature_retired.py-- (1) no tracked file exceptCHANGELOG.mdmatchesghcr.io/microsoft/apm/apm-cli; (2) no trackeddevcontainer/path and no workflow referencesdevcontainers/action,devcontainer features test,devcontainer-featureordevcontainer/src; (3) the installation guide keeps its Dev containers recipe. Uses a regex (not substring) for the URL-like needle pertests.instructions.md.packages/apm-guide/.apm/skills/apm-usage/-- no references to the feature; unchanged. Top-levelREADME.md-- no references; unchanged.Diagrams
N/A -- deletions plus one docs section; no control flow or module boundary changes.
Trade-offs
Branch protection item
Important
The record's Done-when requires the
Devcontainer Feature - Test Resultrequired check to be removed from branch protection. Verified already satisfied:mainhas no classic protection (GET .../branches/main/protection-> 404) and rulesetmain-protection(id 9294522) requires onlygate(GET repos/microsoft/apm/rulesets/9294522). No admin action needed.Issue and approved scope
Issue: Fixes #3520
Human scope-approval comment: #3520 (comment) (
apm-scope:v1, approved by Daniel Meppiel (@danielmeppiel), review contact Daniel Meppiel (@danielmeppiel)).Does this PR complete the issue, or what remains? Completes it: no tracked file outside CHANGELOG history advertises
ghcr.io/microsoft/apm/apm-cli, no workflow builds or tests a dev container feature, the installation docs describe dev container use, the CHANGELOG notes the removal, and the required-check item is already satisfied (see above).Type of change
Testing
Validation evidence
How to test
git grep -n "ghcr.io/microsoft/apm/apm-cli"-> onlyCHANGELOG.md.ls .github/workflows | grep devcontainer-> empty.pytest tests/unit/test_devcontainer_feature_retired.py -q-> 3 passed.Spec conformance (OpenAPM v0.1)
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com