hardis:project:action:run

Description

Command Behavior

Runs one post-deployment action again, outside of a deployment job, after it failed or was stopped by a failure.

When a post-deployment action fails after the merge of a Pull Request, the metadata is already deployed: re-running the whole deployment job is not needed. This command runs only the chosen action in the org, and records the result in the "Deployment Actions" comment of its Pull Request, with who ran it.

• The org branch comes from the org: the major branch whose config/branches/.sfdx-hardis.<branch>.yml has the same targetUsername or instanceUrl, or dev-sandboxes for a developer org. With --org-branch, an org of that branch already authenticated on this computer is used: its targetUsername first, then any user of its instance.
• The action definition is read from the current checkout. When the org is a major org and the current branch is another one, the command warns and asks for confirmation.
• Without --pr and --action-id, it proposes the recent Pull Requests whose actions failed in the org branch, then their failed actions.
• An action with a customUsername runs as that user: when this computer is not authenticated with it, the command offers to log in with it, and checks the login used the right user.
• Once the action succeeds, it offers to run the actions its failure stopped: only the next one, or all of them.
• An action that only runs during validation jobs, or that removes items from the deployment package.xml, cannot be run. A pre-deployment action can, after a confirmation, since the metadata it ran before is already in the org: in agent or CI mode it is refused, re-run the deployment job instead.
• An action never run in the org, or skipped there, is run after a confirmation, and refused in agent or CI mode.

With --select-org, the command lists every org authenticated on this computer, the orgs of the major branches of the pipeline first, and runs the action in the chosen one: as a retry in a major org, as a try in a developer org. The VS Code Deployment Actions tab uses it for Run in another org.

Anyone authenticated to the org can retry an action, production included. A git provider token is required, to record the result in the Pull Request.

Try the actions of your Pull Request in your own org

When the org is not a major org (a developer sandbox or a scratch org), the command runs the actions of a Pull Request there, to test them before the merge: one action, or all of them with --all, pre-deployment actions first, in the order of the actions file. It stops at the first failure, as a deployment does.

• --pr takes the Pull Request number, or draft for the actions file of a branch with no Pull Request yet. Without it, the Pull Request of the current branch is used, or the draft file.
• Validation-only actions and package.xml item removals are skipped: they only make sense during a deployment. A runOnlyOnceByOrg action already done in this org is skipped too.
• The results go to the "Deployment Actions" comment of the Pull Request, in the dev-sandboxes column shared by every developer org, and to its "Backpromotes" comment, in a row for this sandbox and org id: a later backpromote of that sandbox knows the action already ran there, and so does the next run here. They never count as done in a major org, never write "moved", and never turn the comment red. Without a Pull Request (draft) or without a git provider token, they are kept in config/user/deployment-actions/<Pull Request or draft>.json, a folder sfdx-hardis projects keep out of git.
• --all is refused on a major org: a merge runs them there. --dev-org refuses any run on a major org, which the VS Code Run in my org button of an action passes, so a default org that happens to be a major one is never touched.

To close an action that was done by hand, use hardis:project:action:set-status. To fix a wrong definition, move the action to a fix Pull Request with sf hardis:project:action:update --move-to-pr.

See Recover a failed action.

Agent Mode

Supports non-interactive execution with --agent:

sf hardis:project:action:run --agent --pr 123 --action-id abc-123 --org-branch integration --next all
sf hardis:project:action:run --agent --pr draft --all --target-org my-dev-sandbox

Required in agent mode:

• --pr, --action-id
• --org-branch or --target-org
• --allow-branch-mismatch when the current branch is not the org branch

Defaults applied: --next none. The confirmations are skipped with a warning. An action whose customUsername is not authenticated on this computer fails instead of prompting for a login.

Learn by doing

The free Salesforce DevOps with sfdx-hardis course runs this command, click by click, on an org of your own:

• Lab 3.3 - Read the deployment log, and what .forceignore hides from it

Parameters

Examples

$ sf hardis:project:action:run

$ sf hardis:project:action:run --pr 123 --action-id abc-123 --org-branch integration

$ sf hardis:project:action:run --agent --pr 123 --action-id abc-123 --org-branch integration --next all

$ sf hardis:project:action:run --pr draft --all

Comments