Skip to content

chore(delivery): add deprecation notices to LegacyShellDelivery#268

Merged
skevetter merged 2 commits into
mainfrom
f5d9-cf0b-ws-deprecation
May 13, 2026
Merged

chore(delivery): add deprecation notices to LegacyShellDelivery#268
skevetter merged 2 commits into
mainfrom
f5d9-cf0b-ws-deprecation

Conversation

@skevetter

@skevetter skevetter commented May 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add // Deprecated: godoc comments to LegacyShellDelivery struct, all exported methods, and ExecFuncFromDriver in pkg/agent/delivery/legacy_shell.go
  • Add // Deprecated: godoc comments to Script, ExecFunc, LocalFile, InjectOptions, and Inject in pkg/inject/inject.go
  • Add deprecation header comment to pkg/inject/inject.sh
  • Add log.Warnf deprecation warnings in pkg/agent/delivery/factory.go for all code paths that select LegacyShellDelivery
  • No code removed — all functionality preserved

Stacked on PR #267 (f5d9-cf0b-ws-b-k8s-delivery).

Summary by CodeRabbit

  • Deprecations

    • Legacy shell-based agent delivery and injection methods are now deprecated. Platform-native deployment implementations (Docker, Kubernetes) are recommended.
  • New Features

    • Added configurable helper image option for deployment configuration.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 89fd18eb-6f5e-4135-a83e-7c98ba9c732a

📥 Commits

Reviewing files that changed from the base of the PR and between b39c2b4 and d71afa0.

📒 Files selected for processing (4)
  • pkg/agent/delivery/factory.go
  • pkg/agent/delivery/legacy_shell.go
  • pkg/inject/inject.go
  • pkg/inject/inject.sh

📝 Walkthrough

Walkthrough

This PR adds deprecation markers for legacy shell delivery components across the codebase and wires a configurable HelperImage field from factory options through to LocalDockerDelivery. The factory now emits deprecation warnings when routing CustomDriver, KubernetesDriver, or unknown driver types to legacy shell delivery.

Changes

Legacy Shell Deprecation and Helper Image Support

Layer / File(s) Summary
HelperImage field addition
pkg/agent/delivery/factory.go
FactoryOptions struct gains a HelperImage string field for configurable helper image selection in delivery strategies.
Factory integration: deprecation warnings and HelperImage passing
pkg/agent/delivery/factory.go
Factory emits log.Warnf deprecation warnings when selecting legacy shell delivery for CustomDriver, KubernetesDriver, and the default fallback case, and passes opts.HelperImage into LocalDockerDelivery construction.
Deprecation documentation for legacy components
pkg/agent/delivery/legacy_shell.go, pkg/inject/inject.go, pkg/inject/inject.sh
LegacyShellDelivery type, its methods, ExecFuncFromDriver, and legacy injection components (Script, ExecFunc, LocalFile, Inject) receive Deprecated: doc comments indicating platform-native AgentDelivery implementations (LocalDockerDelivery, RemoteDockerDelivery, KubernetesDelivery) are replacements; inject.sh header prepends a deprecation notice.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • devsy-org/devsy#267: Both PRs extend FactoryOptions with HelperImage and modify NewAgentDelivery's driver-based delivery selection and wiring.
  • devsy-org/devsy#266: Both PRs add and wire the FactoryOptions.HelperImage field into LocalDockerDelivery construction.
  • devsy-org/devsy#265: Introduced the legacy shell and factory components that this PR now deprecates and extends with HelperImage support.

Suggested labels

size/m, type/chore

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore(delivery): add deprecation notices to LegacyShellDelivery' accurately summarizes the primary objective and main change in the pull request.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

@skevetter
skevetter force-pushed the f5d9-cf0b-ws-b-k8s-delivery branch from 60a9c77 to ab8a127 Compare May 12, 2026 21:54
@skevetter
skevetter force-pushed the f5d9-cf0b-ws-deprecation branch from 76d575b to effc84c Compare May 12, 2026 21:55
Base automatically changed from f5d9-cf0b-ws-b-k8s-delivery to main May 13, 2026 14:00
@skevetter
skevetter marked this pull request as ready for review May 13, 2026 14:02
@coderabbitai coderabbitai Bot added size/m delivery Delivery e2e tests labels May 13, 2026
@skevetter
skevetter force-pushed the f5d9-cf0b-ws-deprecation branch from effc84c to ad70074 Compare May 13, 2026 14:03
@skevetter
skevetter enabled auto-merge (squash) May 13, 2026 14:03
@netlify

netlify Bot commented May 13, 2026

Copy link
Copy Markdown

Deploy Preview for devsydev canceled.

Name Link
🔨 Latest commit d71afa0
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6a04a61ae732b100083386cc

@github-actions github-actions Bot added size/s and removed size/m labels May 13, 2026
@skevetter
skevetter disabled auto-merge May 13, 2026 14:15
@skevetter
skevetter enabled auto-merge (squash) May 13, 2026 16:23
skevetter added 2 commits May 13, 2026 11:25
…nject.sh

Mark LegacyShellDelivery, its exported methods, ExecFuncFromDriver,
and the inject.sh/inject.go types and functions with Deprecated godoc
comments pointing to platform-native AgentDelivery implementations
(LocalDockerDelivery, RemoteDockerDelivery, KubernetesDelivery).

Add a runtime deprecation warning via log.Warnf in the delivery factory
whenever LegacyShellDelivery is selected. No code removed — everything
remains fully functional.
@skevetter
skevetter force-pushed the f5d9-cf0b-ws-deprecation branch from 8aee9aa to d71afa0 Compare May 13, 2026 16:26
@coderabbitai coderabbitai Bot added the size/l label May 13, 2026
@skevetter
skevetter merged commit 9bc10cc into main May 13, 2026
56 checks passed
@skevetter
skevetter deleted the f5d9-cf0b-ws-deprecation branch May 13, 2026 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant