Skip to content

docs: Set field workflow step#1368

Merged
validbeck merged 3 commits into
mainfrom
beck/sc-15651/documentation-workflow-step-type-for-automated
Jun 11, 2026
Merged

docs: Set field workflow step#1368
validbeck merged 3 commits into
mainfrom
beck/sc-15651/documentation-workflow-step-type-for-automated

Conversation

@validbeck

@validbeck validbeck commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

What and why?

sc-15651

Documentation updated to cover the new Set Field workflow step type, which automatically sets or clears inventory record and artifact field values from workflows.

How to test

Click on the live previews and check the changes:

Workflows

OLD NEW Changes
Workflow step types Workflow step types Added the Set Field workflow step type, including field update controls, clear-field behavior, support for setting multiple fields, and links to inventory and artifact field management.

Training / Administrator Fundamentals

OLD NEW Changes
Using ValidMind for Risk Management Using ValidMind for Risk Management Reflected the same Set Field workflow step type addition in the Administrator Fundamentals risk management training material.

What needs special review?

n/a

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 Jun 10, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label Jun 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

PR Summary

This PR introduces a new documentation section for the 'Set Field' step within the workflow guide. The new section explains how the step automatically sets an inventory record or artifact field value. It provides details on selecting a target field, describing the process of either adding a value or clearing a field by setting it to empty. Additionally, the section includes an interactive element to add multiple fields and hyperlinks to related management documentation for inventory and artifact fields. These changes enhance the clarity of available workflow actions and provide users with direct links for further configuration guidance.

Test Suggestions

  • Render the updated page and verify the new 'Set Field' section displays correctly.
  • Check that the table for 'Set Field' contents renders as expected with proper formatting.
  • Ensure that the tooltip and hover behavior on the step configuration is correct.
  • Confirm that the footnotes link correctly to the respective inventory and artifact management guides.

@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 a review from panchicore June 10, 2026 23:38
@panchicore

Copy link
Copy Markdown
Member

set field is the new man. I feel like its missing something like "use this node when [mention use cases], connect with branch nodes to condition the values" and this information might be right there on the shortcut ticket as the entry point, ideally.

@panchicore panchicore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌮

@validbeck

Copy link
Copy Markdown
Collaborator Author

set field is the new man. I feel like its missing something like "use this node when [mention use cases], connect with branch nodes to condition the values" and this information might be right there on the shortcut ticket as the entry point, ideally.

We had an examples page that became quickly outdated — for now, the workflow docs just describe set up rather than use cases as we have a Story parked for redoing all those examples hopefully in a way that is easier to update. Ty for the suggestion tho!

@validbeck validbeck merged commit 9c38f4c into main Jun 11, 2026
17 of 18 checks passed
@validbeck validbeck deleted the beck/sc-15651/documentation-workflow-step-type-for-automated branch June 11, 2026 15:22
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