Skip to content

docs: reorder readme steps for devcontainer#178

Merged
sunib merged 1 commit into
ConfigButler:mainfrom
scott-david-walker:update-devcontainer-readme-steps
Jul 3, 2026
Merged

docs: reorder readme steps for devcontainer#178
sunib merged 1 commit into
ConfigButler:mainfrom
scott-david-walker:update-devcontainer-readme-steps

Conversation

@scott-david-walker

@scott-david-walker scott-david-walker commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Description

Small change that reflects the order of the steps when running a dev container

Type of Change

  • Documentation update

Summary by CodeRabbit

  • Documentation
    • Reorganized the container setup guide for clearer onboarding.
    • Added a dedicated Prerequisites (Before Reopening In Container) section.
    • Moved the VS Code setup steps into a separate VS Code section while keeping the setup instructions unchanged.

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: cf61eb00-41e5-4480-8d6d-46d4980916d2

📥 Commits

Reviewing files that changed from the base of the PR and between 49ec75f and cf608e4.

📒 Files selected for processing (1)
  • .devcontainer/README.md
✅ Files skipped from review due to trivial changes (1)
  • .devcontainer/README.md

📝 Walkthrough

Walkthrough

Documentation-only change to .devcontainer/README.md that reorganizes the reopening instructions under a new prerequisites heading and keeps the VS Code steps in a dedicated subsection.

Changes

Devcontainer README reorganization

Layer / File(s) Summary
Restructure README headings and VS Code section
.devcontainer/README.md
Adds a "Prerequisites (Before Reopening In Container)" heading and moves the VS Code setup steps into a dedicated subsection beneath it.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is brief but omits most template sections, including Testing, Checklist, Related Issues, and Additional Notes. Fill out the remaining template sections, especially Testing/Checklist and any relevant Related Issues, Screenshots, or Additional Notes.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the doc-only devcontainer README reordering change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sunib
sunib force-pushed the update-devcontainer-readme-steps branch from c8382cc to 94d6b98 Compare July 2, 2026 17:47
@codecov

codecov Bot commented Jul 2, 2026

Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@sunib
sunib force-pushed the update-devcontainer-readme-steps branch from 94d6b98 to 49ec75f Compare July 2, 2026 21:38
sunib added a commit that referenced this pull request Jul 3, 2026
…eouts (#187)

* fix(ci): free runner disk after image loads; diagnose e2e rollout timeouts

External PR #178's run (28623232380) failed with the controller rollout
timing out after a fresh install in the image-refresh lane. The job
summary shows the runner bottomed out at 1.4GB free disk - inside the
kubelet eviction threshold of the k3d node, the exact image-GC /
pod-not-ready failure mode load-image.sh pins against. Nothing about
the failure was fork-specific: the untrusted path (artifact handoff,
local build, import) worked end to end.

- Delete the multi-GB docker-load tarballs right after loading in every
  consumer job; they were sitting on disk for the whole e2e run.
- fail-fast: false on the e2e matrix: quickstart's failure cancelled
  E2E (full) mid-run, losing its signal and erroring its report upload.
- deploy-controller.sh: widen the rollout wait to 300s (fresh installs
  also wait on cert-manager issuing the admission cert) and dump node
  conditions, pods, describe, and events on timeout so the next
  occurrence names its cause in the log.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(e2e): stop k3d DiskPressure evictions with absolute kubelet thresholds

The diagnostics added in the previous commit named the cause directly:
the k3d node reported DiskPressure and evicted/rejected the controller
pod, while the runner still had 3.3GB free. k3s defaults kubelet
eviction to nodefs.available<5% - ~3.6GB of a 72GB CI disk - and the
pressure condition then lingers for the default 5m transition period,
longer than the rollout wait.

- start-cluster.sh: absolute eviction thresholds (1Gi) and a 30s
  pressure transition period on all k3d nodes. Percentages don't
  express "actually almost full" when the node shares the host disk.
  (Invalidates _cluster-ready: next local e2e run rebuilds the cluster.)
- ci.yml e2e job: free ~18GB of unused preinstalled toolchains
  (android, CodeQL, dotnet) before downloading artifacts.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
@sunib
sunib force-pushed the update-devcontainer-readme-steps branch from 49ec75f to cf608e4 Compare July 3, 2026 04:33
@sunib
sunib merged commit 7856f69 into ConfigButler:main Jul 3, 2026
12 checks passed
@sunib

sunib commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Thanks for your first contribution @scott-david-walker!

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