Skip to content

docs: Workflows — Artifact Status Change & User Action Step updates#1336

Merged
validbeck merged 4 commits into
mainfrom
beck/sc-15645/documentation-workflows-user-action-steps
May 21, 2026
Merged

docs: Workflows — Artifact Status Change & User Action Step updates#1336
validbeck merged 4 commits into
mainfrom
beck/sc-15645/documentation-workflows-user-action-steps

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented May 20, 2026

Pull Request Description

What and why?

sc-15645

Docs for new functionality:

  • Artifact Status Change Step
  • Updated User Action Step

How to test

Click on the live previews:

Workflow step types

Conditional step requirements

What needs special review?

I hid the "Workflow configuration examples" page from sidebar view (it's set to search: false but users can still see it if they have the old URL as it's outdated and there's a Story to transition it to be easier to update.

Dependencies, breaking changes, and deployment notes

n/a

Release notes

Covered by:

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@validbeck validbeck self-assigned this May 20, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label May 20, 2026
@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This PR improves the workflow documentation by introducing detailed information about the new Artifact Status Change step type and updating related instructions. The changes include:

  • In the sidebar configuration, a link to the workflow configuration examples is commented out to remove it from display.
  • The conditional requirements page now describes how to set conditions for the Artifact Status Change step, with new step-by-step instructions detailing the process for adding rules and groups.
  • The workflow step types documentation is updated to include the Artifact Status Change configuration, with an added table describing the relevant fields and their usage. Additionally, a new optional field (step title) has been introduced for the User Action step.
  • Minor text clarifications have been made to improve the guidance provided for selecting fields, including an updated prompt to click on "Add All" in the User Action step.
  • Some callout blocks have been commented out in multiple files to streamline the presentation of help information.
  • Other small UI changes like grid layout adjustments in the workflow setup page and search configuration for workflow examples have also been applied.

Overall, these updates enhance the clarity and usability of the workflow documentation, especially concerning the new Artifact Status Change features.

Test Suggestions

  • Verify that the Artifact Status Change step documentation is correctly displayed and formatted with all the new fields and descriptions.
  • Ensure that the commented-out links (e.g., workflow configuration examples) do not show up in the live site/sidebar.
  • Check that the updated instructions for adding conditional rules and groups are clear and consistent across the documentation.
  • Validate that the new 'step title' field in the User Action step is properly rendered in the UI and its description is accurate.
  • Perform a full documentation build to ensure that the markdown comments and callout blocks are correctly processed or hidden as intended.

@github-actions
Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@validbeck validbeck requested review from jamadriz and nrichers May 20, 2026 00:35
@validbeck validbeck merged commit 37e643c into main May 21, 2026
9 of 10 checks passed
@validbeck validbeck deleted the beck/sc-15645/documentation-workflows-user-action-steps branch May 21, 2026 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants