[#2733] Renamed the container-image push scripts and variables from 'deploy' to 'push' and dropped the container-registry deploy type.#2737
Conversation
…ry' and dropped it as a deploy type.
…try' against password tracing and invalid maps.
WalkthroughThe PR removes container-registry deployment options, renames the registry push flow and related helpers, updates DB-image CI wiring to the new push commands and variables, and refreshes matching docs and tests. ChangesContainer registry rename and deploy-type cleanup
Sequence Diagram(s)sequenceDiagram
participant database job
participant push-db-image
participant push-container-registry
participant login-container-registry
participant Docker registry
database job->>push-db-image: run push-db-image
push-db-image->>push-container-registry: invoke with VORTEX_PUSH_CONTAINER_REGISTRY_MAP
push-container-registry->>login-container-registry: run registry login
login-container-registry->>Docker registry: docker login --password-stdin
push-container-registry->>Docker registry: docker push tagged image
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.ahoy.yml:
- Line 345: The deploy confirmation prompt in ahoy confirm is advertising the
wrong allowed type list. Update the message so it matches the current deploy
contract used by the deploy flow, replacing the outdated “code” entry with
“artifact” and adding “lagoon” alongside “webhook”; keep the prompt text in sync
with the deploy command’s supported types so users are guided correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 61e9e6b7-5412-41e1-832d-8f8a424ca4fc
⛔ Files ignored due to path filters (6)
.vortex/docs/static/img/diagram-scripts-dark.svgis excluded by!**/*.svg.vortex/docs/static/img/diagram-scripts-light.svgis excluded by!**/*.svg.vortex/installer/tests/Fixtures/handler_process/_baseline/.ahoy.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/deploy_types_all_circleci/.envis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/deploy_types_all_gha/.envis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/deploy_types_container_image/.envis excluded by!.vortex/installer/tests/Fixtures/**
📒 Files selected for processing (15)
.ahoy.yml.vortex/docs/content/deployment/README.mdx.vortex/docs/content/deployment/docker.mdx.vortex/installer/CLAUDE.md.vortex/installer/src/Prompts/Handlers/DeployTypes.php.vortex/installer/tests/Functional/Handlers/DeployTypeHandlerProcessTest.php.vortex/tooling/src/deploy.vortex/tooling/src/deploy-db-image.vortex/tooling/src/login-container-registry.vortex/tooling/src/push-container-registry.vortex/tooling/tests/unit/deploy-artifact.bats.vortex/tooling/tests/unit/deploy-db-image.bats.vortex/tooling/tests/unit/deploy.bats.vortex/tooling/tests/unit/login-container-registry.bats.vortex/tooling/tests/unit/push-container-registry.bats
💤 Files with no reviewable changes (3)
- .vortex/docs/content/deployment/docker.mdx
- .vortex/docs/content/deployment/README.mdx
- .vortex/installer/src/Prompts/Handlers/DeployTypes.php
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
📖 Documentation preview for this pull request has been deployed to Netlify: https://6a3e16d5ee3ecec6edd1239f--vortex-docs.netlify.app This preview is rebuilt on every commit and is not the production documentation site. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2737 +/- ##
===========================================
- Coverage 99.51% 86.22% -13.29%
===========================================
Files 9 89 +80
Lines 205 4560 +4355
Branches 47 3 -44
===========================================
+ Hits 204 3932 +3728
- Misses 1 628 +627 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…k', 'lagoon' deploy types.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
…-push variables from 'deploy' to 'push'.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.vortex/docs/.utils/variables/extra/ci.variables.sh:
- Line 21: The shellvar source comment for the CI variable still says
“deployment” even though the symbol was renamed to the PUSH variant, so update
the wording to “push” for consistency. Edit the comment near the related
variable definition in the shellvars source so it matches the new push
terminology and propagates correctly to the generated documentation, including
the description used by variables.mdx.
In @.vortex/tooling/tests/unit/push-db-image.bats:
- Around line 22-101: The proceed flag cleanup in the test helper is incomplete,
so `VORTEX_EXPORT_DB_CONTAINER_REGISTRY_PUSH_PROCEED` can leak between tests.
Update `.vortex/tooling/tests/_helper.bash` in `setup()` to unset this renamed
variable alongside `VORTEX_DB_IMAGE`, using the existing helper setup logic so
`push-db-image` tests start from a clean environment.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: c53696f0-6b05-4e6f-b0b2-2bce4a176391
⛔ Files ignored due to path filters (21)
.vortex/installer/tests/Fixtures/handler_process/_baseline/.ahoy.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/ciprovider_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/code_coverage_provider_codecov_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/deploy_types_all_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/deploy_types_none_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/migration_disabled_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/migration_enabled_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/timezone_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_lint_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_groups_no_be_tests_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_groups_no_fe_lint_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_groups_no_fe_lint_no_theme_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_no_behat_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_no_eslint_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_no_jest_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_no_phpcs_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_no_phpstan_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_no_phpunit_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_no_rector_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/handler_process/tools_no_stylelint_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**
📒 Files selected for processing (11)
.ahoy.yml.circleci/config.yml.circleci/vortex-test-common.yml.vortex/docs/.utils/variables/extra/ci.variables.sh.vortex/docs/content/development/variables.mdx.vortex/tests/generate-vortex-dev-circleci.vortex/tooling/src/push-container-registry.vortex/tooling/src/push-db-image.vortex/tooling/tests/unit/deploy-db-image.bats.vortex/tooling/tests/unit/push-container-registry.bats.vortex/tooling/tests/unit/push-db-image.bats
💤 Files with no reviewable changes (1)
- .vortex/tooling/tests/unit/deploy-db-image.bats
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
…ated the flag in the test helper.
|
Code coverage (threshold: 90%) Per-class coverage |
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
|
Code coverage (threshold: 90%) Per-class coverage |
Closes #2733
Summary
Renamed the registry-push tooling from
deploytopushand droppedcontainer_registryas aVORTEX_DEPLOY_TYPESdeployment option. In Vortex, "deploy" means deploying the application; pushing an image to a registry is apush. The shipped scriptsdeploy-container-registryanddeploy-db-imagebecomepush-container-registryandpush-db-image, theirVORTEX_DEPLOY_CONTAINER_REGISTRY*variables becomeVORTEX_PUSH_CONTAINER_REGISTRY*, andVORTEX_EXPORT_DB_CONTAINER_REGISTRY_DEPLOY_PROCEEDbecomesVORTEX_EXPORT_DB_CONTAINER_REGISTRY_PUSH_PROCEED. The CI database-image push is unaffected - it keeps pushing the image through the renamed scripts. Both registry scripts were also hardened (password tracing, map validation, tag detection) with regression tests.Changes
Script and variable renames (
deploy→push)deploy-container-registry→push-container-registryanddeploy-db-image→push-db-image(scripts and BATS tests), rewording their messages from "deployment" to "push".VORTEX_DEPLOY_CONTAINER_REGISTRY,_MAP,_IMAGE_TAG,_USER, and_PASSvariables to theVORTEX_PUSH_CONTAINER_REGISTRY*family (the genericVORTEX_CONTAINER_REGISTRY*fallbacks are unchanged).VORTEX_EXPORT_DB_CONTAINER_REGISTRY_DEPLOY_PROCEED→VORTEX_EXPORT_DB_CONTAINER_REGISTRY_PUSH_PROCEED.deployrouter,.circleci/config.yml,.circleci/vortex-test-common.yml, thegenerate-vortex-dev-circlecigenerator, and theci.variables.shdocumentation source.Dropped
container_registryas a deploy typecontainer_registrydispatch from thedeployrouter and the "Container image" option from the installerDeployTypeshandler (with its process-test scenarios and thedeploy_types_container_imagefixture).docker.mdxdeployment doc and itsdeployment/README.mdxentry, removed the label from the architecture SVG diagrams, dropped it from the.ahoy.ymldeploy hint, and removed the conditional-token row from the installerCLAUDE.md.container_imagewhile the router only matchedcontainer_registry, so they never connected.Corrected the deploy-types list
deployrouter contract and the.ahoy.ymlprompt from the invalidcodeto the actually-dispatchedartifact, webhook, lagoon.Hardening (
push-container-registry,login-container-registry)VORTEX_DEBUG=1.service=or=image) are rejected with a clear error.host:portis not mistaken for a tag.VORTEX_EXPORT_DB_CONTAINER_REGISTRY_PUSH_PROCEEDin the test helper'ssetup().Regenerated the installer snapshots/fixtures and the
variables.mdxdocumentation.Before / After
Screenshots
N/A - non-visual tooling change.