Skip to content

Removed the Shellvar container after each 'update-docs.sh' run with 'docker run --rm'. - #3347

Merged
AlexSkrypnyk merged 2 commits into
mainfrom
feature/shellvar-docker-rm
Nov 17, 2026
Merged

AlexSkrypnyk merged 2 commits into
mainfrom
feature/shellvar-docker-rm

Conversation

@AlexSkrypnyk

@AlexSkrypnyk AlexSkrypnyk commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Summary

.vortex/docs/.utils/update-docs.sh now runs the drevops/shellvar:1.7.0 extraction with docker run --rm, so Docker deletes the container as soon as shellvar extract exits.

Without --rm, every ahoy update-docs run left behind an exited container with a random name like condescending_williams or upbeat_villani. On a machine that regenerates the variables docs regularly they pile up: one dev machine had 14 of them from the last 6 days, and docker ps -a filled up with noise.

After merge, ahoy update-docs leaves no container behind and content/development/variables.mdx comes out byte-identical. Containers already left behind aren't touched; clear them once with docker container prune or docker rm filtered on ancestor=drevops/shellvar:1.7.0. Every other docker run in the repo already passes --rm or is a deliberate long-running container.

Before / After

BEFORE                                   AFTER

ahoy update-docs                         ahoy update-docs
      │                                        │
      ▼                                        ▼
docker run drevops/shellvar extract      docker run --rm drevops/shellvar extract
      │                                        │
      ▼                                        ▼
variables.mdx updated                    variables.mdx updated
      │                                        │
      ▼                                        ▼
container "upbeat_villani"               container removed on exit
left in Exited (0) state                 (nothing left in docker ps -a)
 + 1 more per run, forever

Changes

  • .vortex/docs/.utils/update-docs.sh: added --rm to the docker run that calls shellvar extract.

Checked by running ahoy update-docs: the generated docs didn't change and no new drevops/shellvar container showed up in docker ps -a.

Summary by CodeRabbit

  • Chores
    • Temporary containers used during documentation updates are now removed automatically after they exit.

@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The Shellvar extraction command in the documentation update script now passes --rm to Docker. The script’s other inputs and processing steps are unchanged.

Changes: Documentation update

Layer / File(s) Summary
Shellvar extraction command
.vortex/docs/.utils/update-docs.sh
The Docker command now includes --rm to remove the container after it exits.

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

Merge Risk: Minimal · up to ab99a

Merge Risk: ⚪ Minimal · up to ab99a

The documentation update script now removes its Shellvar container after each run instead of leaving exited containers behind. The change is small and low risk, and it is ready to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title says the Shellvar container is removed after each update-docs.sh run using docker run --rm. The raw summary and objectives confirm that --rm was added to the docker run invocation that runs …
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.
Full details: Title check

Explanation

The title says the Shellvar container is removed after each update-docs.sh run using docker run --rm. The raw summary and objectives confirm that --rm was added to the docker run invocation that runs shellvar extract in .vortex/docs/.utils/update-docs.sh, so Docker removes the container on exit. The title matches the main change. It is a little long, and the wording 'Removed ... with' describes the effect and the method, but it is accurate and specific.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between f6e7c0a and 0ff85cb.

Files selected for processing: 1

  • .vortex/docs/.utils/update-docs.sh

Included review availability: This review used your included allowance. 1 included review remains after this review. Your included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.

@AlexSkrypnyk
AlexSkrypnyk enabled auto-merge (squash) November 17, 2026 08:11
@AlexSkrypnyk AlexSkrypnyk added the AUTOMERGE Pull request has been approved and set to automerge label Nov 17, 2026
@AlexSkrypnyk AlexSkrypnyk added this to the 1.43.0 milestone Nov 17, 2026
@github-actions

github-actions Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

📖 Documentation preview for this pull request has been deployed to Netlify:

https://6afc12d2f4e632c245c778e0--vortex-docs.netlify.app

This preview is rebuilt on every commit and is not the production documentation site.

@github-actions

This comment has been minimized.

@AlexSkrypnyk

This comment has been minimized.

@github-actions

This comment has been minimized.

@AlexSkrypnyk

This comment has been minimized.

1 similar comment
@AlexSkrypnyk

This comment has been minimized.

@github-actions

This comment has been minimized.

@codecov

codecov Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.66%. Comparing base (f6e7c0a) to head (ab99a5d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3347      +/-   ##
==========================================
+ Coverage   92.47%   92.66%   +0.18%     
==========================================
  Files         107      115       +8     
  Lines        4944     5110     +166     
  Branches        3       49      +46     
==========================================
+ Hits         4572     4735     +163     
- Misses        372      375       +3     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

This comment has been minimized.

@AlexSkrypnyk

This comment has been minimized.

@github-actions

This comment has been minimized.

@AlexSkrypnyk

This comment has been minimized.

@github-actions

Copy link
Copy Markdown

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   100.00% (233/233)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@AlexSkrypnyk

Copy link
Copy Markdown
Member Author

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   100.00% (233/233)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@AlexSkrypnyk
AlexSkrypnyk merged commit 3696844 into main Nov 17, 2026
54 checks passed
@AlexSkrypnyk
AlexSkrypnyk deleted the feature/shellvar-docker-rm branch November 17, 2026 09:00
@github-project-automation github-project-automation Bot moved this from BACKLOG to Release queue in Vortex 1.x Nov 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A4 Board worker 4 AUTOMERGE Pull request has been approved and set to automerge

Projects

Status: Release queue

Development

Successfully merging this pull request may close these issues.

1 participant