Artifacts

Workflow steps produce artifacts that populate the Push Request. There are three types of artifacts, each created with a dedicated CLI command.

Artifact Types

Content

Content artifacts add rich text to the Push Request overview — typically a generated PR title and description.

airlock artifact content --title "Add user authentication" --body "Implements OAuth2 login flow with..."

Comment

Comment artifacts attach inline review comments to specific files and lines in the Changes tab.

airlock artifact comment \
  --file src/auth.ts \
  --line 42 \
  --message "Consider using a constant for the token expiry" \
  --severity warning

Patch

Patch artifacts suggest code changes that appear in the Patches tab for review.

airlock artifact patch \
  --title "Fix import ordering" \
  --explanation "Sorted imports alphabetically per project convention"

Patch artifacts capture the current worktree diff as the patch content. Pre-freeze patches are applied automatically; post-freeze patches are queued for manual review.

See the CLI Reference for full flag details on each command.

How Artifacts Populate the Push Request

Artifact Type	Desktop App Tab
Content	Overview — Title and description
Comment	Changes — Inline comments on the diff
Patch	Patches — Suggested changes to accept or reject

Producing Artifacts in Custom Steps

Any workflow step can produce artifacts by calling the airlock artifact commands. For example, a custom linting step might produce both patches (auto-fixes) and comments (warnings):

- name: custom-lint
  run: |
    # Run linter and apply fixes
    eslint --fix src/
    airlock artifact patch --title "ESLint auto-fixes" --explanation "Applied ESLint auto-fix rules"

    # Add a comment for manual-fix issues
    airlock artifact comment --file src/index.ts --line 10 \
      --message "Unused variable 'foo'" --severity warning

Push Requests — How artifacts appear in the Push Request UI
Custom Steps — Writing steps that produce artifacts