Skip to content

chore(devcontainer): retire the unpublished Dev Container Feature - #3642

Merged
Daniel Meppiel (danielmeppiel) merged 4 commits into
mainfrom
danielmeppiel-retire-devcontainer-feature-3520
Nov 12, 2026
Merged

Daniel Meppiel (danielmeppiel) merged 4 commits into
mainfrom
danielmeppiel-retire-devcontainer-feature-3520

Conversation

@danielmeppiel

Copy link
Copy Markdown
Collaborator

Description

TL;DR

Retires the never-published Dev Container Feature: deletes devcontainer/ (feature sources, bats tests, three bats submodules), .gitmodules, and both devcontainer-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.yml remained on main, although the publish trigger was commented out and nothing was ever published to ghcr.io.
  • .github/workflows/devcontainer-feature-test.yml still ran a nightly matrix for an artifact the project decided not to ship (Devcontainer feature not published #1273 closed as not planned).
  • [!] The installation docs had no dev container guidance, so the only "how-to" lived in the feature README being removed.

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)

# Change
1 Delete devcontainer/ and its bats submodules; delete .gitmodules (it only held those three submodules).
2 Delete devcontainer-feature-publish.yml and devcontainer-feature-test.yml.
3 Add ## Dev containers to getting-started/installation.md: postCreateCommand with the standalone installer, or the official Python feature plus pip install apm-cli; community feature marked as maintained outside this project.
4 Add tests/unit/test_devcontainer_feature_retired.py guard.
5 CHANGELOG ### Removed entry.

Implementation (HOW)

  • devcontainer/**, .gitmodules -- pure deletion (17 tracked paths incl. 3 gitlinks). No other file referenced them (git grep -i devcontainer / bats clean outside CHANGELOG history and unrelated "devcontainers" wording in auth docs).
  • .github/workflows/devcontainer-feature-*.yml -- deleted. merge-gate.yml EXPECTED_CHECKS never listed them, so the gate aggregator is unaffected.
  • docs/src/content/docs/getting-started/installation.md -- new section after pip 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 except CHANGELOG.md matches ghcr.io/microsoft/apm/apm-cli; (2) no tracked devcontainer/ path and no workflow references devcontainers/action, devcontainer features test, devcontainer-feature or devcontainer/src; (3) the installation guide keeps its Dev containers recipe. Uses a regex (not substring) for the URL-like needle per tests.instructions.md.
  • packages/apm-guide/.apm/skills/apm-usage/ -- no references to the feature; unchanged. Top-level README.md -- no references; unchanged.

Diagrams

N/A -- deletions plus one docs section; no control flow or module boundary changes.

Trade-offs

  • Chose option 1 from the issue (remove, document a recipe in the docs) per the approved scope record, rather than keeping a reduced recipe directory in the repo.
  • The community feature is named but not endorsed or tested (out of scope per the record).

Branch protection item

Important

The record's Done-when requires the Devcontainer Feature - Test Result required check to be removed from branch protection. Verified already satisfied: main has no classic protection (GET .../branches/main/protection -> 404) and ruleset main-protection (id 9294522) requires only gate (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

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

Testing

  • Tested locally
  • All existing tests pass (CI is the authority; full suite not run locally by maintainer instruction)
  • Added tests for new functionality (if applicable)
Validation evidence
$ pytest tests/unit/test_devcontainer_feature_retired.py -q -p no:xdist
3 passed

# Mutation-break (each restored afterwards):
M1 append "ghcr.io/microsoft/apm/apm-cli:1" to installation.md  -> 1 failed, 2 passed
M2 restore devcontainer-feature-test.yml                        -> 1 failed, 2 passed
M3 rename "## Dev containers" heading                           -> 1 failed, 2 passed
restored                                                        -> 3 passed

# Lint mirror on HEAD merged with origin/main
$ ruff check src/ tests/ scripts/lint_architecture_boundaries.py scripts/architecture_linter/ scripts/windows_native_symlink_probe_entry.py
All checks passed!
$ ruff format --check (same paths)
2160 files already formatted
$ pylint --disable=all --enable=R0801 --min-similarity-lines=10 --fail-on=R0801 ...
Your code has been rated at 10.00/10
$ bash scripts/lint-auth-signals.sh
[+] auth-signal lint clean

How to test

  • git grep -n "ghcr.io/microsoft/apm/apm-cli" -> only CHANGELOG.md.
  • ls .github/workflows | grep devcontainer -> empty.
  • pytest tests/unit/test_devcontainer_feature_retired.py -q -> 3 passed.
  • Read the new "Dev containers" section on the installation page.

Spec conformance (OpenAPM v0.1)

  • N/A -- this PR does not change OpenAPM-observable behaviour.

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

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>
Copilot AI balanced review requested due to automatic review settings November 12, 2026 15:56
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

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 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>
@danielmeppiel

Copy link
Copy Markdown
Collaborator Author

APM Review Panel: ship_now

Retires the unpublished Dev Container Feature, keeps APM's official distribution to the ratified channels, and points dev container users to supported recipes plus the community-maintained feature.

panel-mode=lean; personas=doc-writer,apm-ceo

cc Sergio Sisternes (@sergio-sisternes-epam) -- a fresh advisory pass is ready for your review.

This is a clean scope reduction aligned with the 2026-11-10 distribution-channel decision, which ratified the official channels and declined an official devcontainer feature (#1273). The PR removes 17 paths under devcontainer/, both devcontainer-feature workflows, and .gitmodules, eliminating maintenance surface and nightly CI for an artifact that was never published. The new "Dev containers" section in the installation guide gives users a working recipe (install.sh, with the --prefix route for root containers and a PATH reminder for non-root users, or the Python feature plus pip) and a non-endorsing pointer to ghcr.io/postfinance/devcontainer-features/apm.

The doc-writer's two recommended findings (root-container failure and the PATH gap when postCreateCommand runs without a terminal) were verified against install.sh and folded in this PR (923dd0d). No findings remain open. Three mutation-tested guards in tests/unit/test_devcontainer_feature_retired.py keep the stale GHCR reference, feature sources and feature workflows from coming back, and keep the docs recipe in place. The main ruleset requires only the gate check, and merge-gate never listed the devcontainer check, so no ruleset edit is needed.

Aligned with: OSS community-driven (points to the community feature without endorsing or testing it); pragmatic as npm (install.sh stays the front-door recipe for dev containers).

Panel summary

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 shows sh -s -- --prefix /usr/local for 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.

@danielmeppiel
Daniel Meppiel (danielmeppiel) merged commit e194a7d into main Nov 12, 2026
25 checks passed
@danielmeppiel
Daniel Meppiel (danielmeppiel) deleted the danielmeppiel-retire-devcontainer-feature-3520 branch November 12, 2026 16:16
Daniel Meppiel (danielmeppiel) added a commit to McNultyyy/apm that referenced this pull request Nov 12, 2026
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>
Daniel Meppiel (danielmeppiel) added a commit that referenced this pull request Nov 12, 2026
Pick up e194a7d (#3642) and 1a37071 (#3600). CHANGELOG.md
conflicted textually under ### Fixed; resolved by keeping main's #3600
entry and this PR's #3604 entry (no entry dropped).

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.

[FEATURE] Retire the unpublished Dev Container Feature (or reduce it to an install.sh recipe)

2 participants