Skip to content

Delivery ​

Plan and run a delivery, per module or for the whole project; internal and public channels.

deliveries ​

effortless_deliveries — Stability: beta · project

Delivery log, most recent first: date, channel, module, tag, version, repository, outcome; plus each target's channels. Read-only.

💬 You ask your agent

« Show me the delivery log: which versions went out, on which channel? »

→ The agent callseffortless_deliveries

No parameters.

release_apply ​

effortless_release_apply — Stability: beta · project

Runs the selected release steps (steps, bump) FOR REAL: version bump (project.version + settings.release.version_files, checked before writing), commit and push (fast-forward merge only), tag and GitHub release (gh), build and artifact upload. stack targets a single module (its version, repository, tag and delivery); absent = the whole project. The first failing step stops the chain; a step impossible for lack of a tool returns a named handoff. Outbound actions: call only after explicit consent. Gated (semi-auto).

💬 You ask your agent

« Go ahead and ship the site module as a patch: version bump, commit, tag, GitHub release and artifacts. »

→ The agent callseffortless_release_apply
  • steps = bump_version,git_flow,tag_release,delivery
  • bump = patch
  • stack = site
NameTypeRequiredDescription
stepsstringyesSteps to run, as a CSV list or JSON array of ids among bump_version, git_flow, tag_release, update_docs and delivery; unknown ids are ignored and an empty selection runs nothing. Required.
bumpstringnoBump level: patch (default), minor or major; any other value counts as patch.
stackstringnoId of the stack (module) to deliver: its version, repository, tag (vX.Y.Z in its own repository, <stack>-vX.Y.Z in the project's) and delivery; absent means the whole project.

release_channels_set ​

effortless_release_channels_set — Stability: beta · project

Sets a stack's internal (empty = origin) and public (empty = none) release repositories; default = the whole project.

💬 You ask your agent

« For the site module, set the internal repo to ArboRithm/site-internal and the public one to ArboRithm/site. »

→ The agent callseffortless_release_channels_set
  • stack = site
  • internal = ArboRithm/site-internal
  • public = ArboRithm/site
NameTypeRequiredDescription
stackstringyesId of the stack (module); default means the whole project. Required.
internalstringnoInternal release repository (owner/name); empty means the origin repository; absent leaves it unchanged.
publicstringnoPublic release repository (owner/name); empty removes the public channel; absent leaves it unchanged.

release_config_set ​

effortless_release_config_set — Stability: beta · project

Configures the release fields (git_flow, tag, update_docs) in effortless.json.

💬 You ask your agent

« Configure the release: enable the git flow, the version tag and the doc updates. »

→ The agent callseffortless_release_config_set
  • git_flow = true
  • tag = true
  • update_docs = true
NameTypeRequiredDescription
git_flowbooleannoIf true, the release plan includes the Git flow step (release branch); at least one of git_flow, tag, update_docs is required.
tagbooleannoIf true, the release plan includes the creation of the version tag.
update_docsbooleannoIf true, the release plan includes the documentation update step.

release_config_show ​

effortless_release_config_show — Stability: beta · project

Effective release configuration of the project. Read-only.

💬 You ask your agent

« What is the project's release configuration? »

No parameters.

release_delivery_set ​

effortless_release_delivery_set — Stability: beta · project

Configures the release delivery (stack, build command, artifacts) in effortless.json.

💬 You ask your agent

« For the app module, configure delivery: build with `pnpm build`, artifacts in dist/*.dmg. »

→ The agent callseffortless_release_delivery_set
  • stack = app
  • build_command = pnpm build
  • artifacts = dist/*.dmg
NameTypeRequiredDescription
stackstringyesId of the targeted stack (or default); an undeclared stack is refused. Required.
build_commandstringyesBuild command that produces the delivery artifacts. Required.
artifactsstringnoGlobs or paths of the produced artifacts, as a comma-separated list or JSON array; absent keeps the globs already recorded for this stack.

release_plan ​

effortless_release_plan — Stability: beta · project

Release plan (version bump + deliverables) for the whole project, or for one stack (stack): its version, repository and tag. Read-only.

💬 You ask your agent

« Prepare the release plan for a minor bump of the site module: version, repo and tag. »

→ The agent callseffortless_release_plan
  • bump = minor
  • stack = site
NameTypeRequiredDescription
bumpstringnoBump level: patch (default), minor or major; any other value counts as patch.
stackstringnoId of the stack (module) to plan for: its version, repository and tag; absent means the whole project.

release_promote ​

effortless_release_promote — Stability: beta · project

Publishes to the public repository a version already delivered internally, as is (same tag, same artifacts). Refused without a public repository, without an internal release, if already public, in semi-auto, or if confirm does not repeat the tag. Outgoing and irreversible: only after the user's explicit consent.

💬 You ask your agent

« Go ahead and publish the site module v1.4.1 to the public repo, already delivered internally; I confirm tag v1.4.1. »

→ The agent callseffortless_release_promote
  • stack = site
  • tag = v1.4.1
  • confirm = v1.4.1
NameTypeRequiredDescription
stackstringnoId of the stack (module) whose version is published; absent means the whole project.
tagstringyesTag already delivered internally that is to be published (for example v1.4.1, site-v1.4.1). Required.
confirmstringyesConfirmation: the same tag again, given only after the user's explicit agreement. Required.

Effortless — ArboRithm