Skip to content

docs: moving a pipeline from the run-experiment action - #83

Merged
achoimet merged 1 commit into
mainfrom
docs/migrate-from-run-experiment
Sep 30, 2026
Merged

achoimet merged 1 commit into
mainfrom
docs/migrate-from-run-experiment

Conversation

@achoimet

Copy link
Copy Markdown
Member

Instead of rebuilding steadybit/run-experiment on top of the CLI, the action will be deprecated slowly, and customers move to the CLI. None of the wrapper was written, so nothing is removed; this only changes what the repository says.

  • README, under In CI: a section on moving from the action. It has a before-and-after step, and a table mapping every input of the action to an experiment run flag or variable, including the units that differ (ms in the action, a duration here). It also shows how to get the action's outputs from --report run.json. One difference is spelled out: the action retries 3 times while another experiment runs by default, and the CLI only does so with --busy-retries.
  • CHANGELOG: the v6.2.0 entry says the parity flags let pipelines move to the CLI, instead of letting the action run on it. There is a v6.2.2 line for the new section.
  • e2e/platform.sh: a comment reworded the same way.

The parity flags from v6.2.0 stay. They are what makes the move a flag-for-flag change.

Deprecating the action itself happens in steadybit/run-experiment, and is not part of this PR: a deprecation notice in its README, and a deprecationMessage on the action or a warning in its log pointing here.

…g deprecated

The action is not rebuilt on the CLI after all: customers move to the CLI.
The README maps each of the action's inputs to a flag and its outputs to the
JSON report, and the changelog and the platform test no longer speak of the
action running on the CLI.
@achoimet
achoimet merged commit 7f6be20 into main Sep 30, 2026
13 checks passed
@achoimet
achoimet deleted the docs/migrate-from-run-experiment branch September 30, 2026 08:01
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 30, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant