[SC-17811] Document the Create Artifact workflow step - #1465
Open
juanmleng wants to merge 4 commits into
Open
Conversation
Adds the step type entry with its configuration table, and a worked example for the case nobody derives unaided: the step creates a new artifact every time it is reached, which is right for a recurring event and wrong for a continuing state. The example covers guarding the step with its own condition over an aggregate field counting open artifacts, and when a Condition Branch is needed instead. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The suggested guard was a condition over an aggregate field counting open artifacts, but the workflow condition builder excludes aggregate fields, so it cannot be authored in the UI at all. Removing the section rather than documenting a workaround that does not exist. Keeps the factual warning that the step creates an artifact every time it is reached, and the note that a blocked condition parks the execution without reaching an End step. Renames the Field Values config row to Artifact Fields to match the panel. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Three things the page did not say, all of them behaviour that landed while it sat in draft. The assignee fallback was one sentence short. Leaving it empty assigns the artifact to the user the workflow runs as, and which user that is depends on how the run started: the workflow's author on a schedule, the person whose action triggered it otherwise. That distinction is the whole reason the fallback is defensible, so it belongs where someone is deciding whether to set an assignee. Field values now say what happens with a field the artifact type marks required on registration. The step cannot create an artifact without one, and the workflow no longer saves without it — before, a step could be configured, saved, and then fail on every single run with nothing on the page to warn against it. The Source section grew a trigger, a raised date and a link to the run. The page described only the workflow name, which understates what an artifact now carries about where it came from. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Deleting a severity renumbers the remaining ones, so a step configured with it is now refused in settings rather than silently repointed. Says so where the severity is configured, and links the page that manages them. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
juanmleng
marked this pull request as ready for review
August 19, 2026 20:35
Contributor
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
cachafla
approved these changes
Aug 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Description
What and why?
Documents the new Create Artifact workflow step: what it does, what you configure on it, and where it can be used.
Also removes a section that described something you cannot actually do. It suggested suppressing repeat artifacts with a condition over a field counting open artifacts, but the workflow condition builder does not offer those fields, so the guard cannot be built in the UI. Rather than document a workaround that does not exist, the section is gone.
One useful fact was kept from it and moved into the step-types callout: when a step's condition blocks, the execution stops there without reaching an End step, so use a Condition Branch when the other path matters.
Also renames the config table row Field Values to Artifact Fields, to match the panel.
How to test
Live preview of the changed page — jump to the Create Artifact section. (Preview home.)
Read that section against the panel in the product, and check
workflow-configuration-examples.qmdis back to matchingmain.What needs special review?
Whether cutting the repeat-artifact section is the right call, or whether it should stay with a note that it is not yet buildable in the UI.
Dependencies, breaking changes, and deployment notes
Describes a feature that is not released yet — hold until the platform change ships.
Release notes
documentation