Skip to content

[SC-16429] Document artifact field-change workflow triggers - #1432

Merged
cachafla merged 4 commits into
mainfrom
codex/sc-16429-artifact-field-change-workflows
Jul 23, 2026
Merged

[SC-16429] Document artifact field-change workflow triggers#1432
cachafla merged 4 commits into
mainfrom
codex/sc-16429-artifact-field-change-workflows

Conversation

@cachafla

@cachafla cachafla commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Pull Request Description

What and why?

Documents the artifact workflow On Field Change trigger added by SC-16429.

The workflow setup guide previously listed field-change triggers only for inventory record workflows. This change adds the artifact option and explains:

  • How to select an Artifact Field to Monitor
  • How available fields are scoped to the selected artifact type
  • That fields shared across artifact types remain available
  • That record fields displayed from the parent record are not supported as triggers
  • How date and date-time artifact fields can schedule the workflow start

The instructions live in a shared source used by both the workflow guide and administrator training.

This PR also captures the repeatable documentation-coverage workflow developed while resolving this release ticket:

  • Adds concise coverage-review guardrails to AGENTS.md
  • Adds a repository-owned validmind-docs-coverage skill
  • Exposes repository skills to Claude through .claude/skills -> ../skills
  • Adds a validated helper that renders multiple Quarto pages one at a time

How to test

Validated the new skill and helper:

  • python3 /Users/andres/.codex/skills/.system/skill-creator/scripts/quick_validate.py skills/validmind-docs-coverage
  • bash -n skills/validmind-docs-coverage/scripts/render-pages.sh
  • test -f .claude/skills/validmind-docs-coverage/SKILL.md

Rendered both affected pages with the helper:

  • guide/workflows/configure-workflows.qmd
  • training/administrator-fundamentals/using-validmind-for-risk-management.qmd

Both pages rendered successfully and contain the new artifact trigger instructions. The existing unresolved validmind/validmind.qmd link warnings remain unrelated to this change.

Documentation preview

Review the documentation changes live after the latest validate run completes:

Review the source-only agent guidance on GitHub:

What needs special review?

Please confirm:

  • The field-scoping and parent-record-field limitation match the released workflow modal behavior.
  • The AGENTS.md guidance is concise enough to remain durable.
  • The repository-owned skill covers the repeatable workflow without duplicating broader release-wide gap-detection skills.

Dependencies, breaking changes, and deployment notes

Documents behavior delivered by:

Both implementation PRs are merged. There are no breaking changes or special documentation deployment steps.

Release notes

Artifact workflows can now start when a selected artifact field changes. Available fields depend on the selected artifact type, and date fields can schedule the workflow start. Learn more about configuring workflows.

Checklist

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

@cachafla cachafla added the documentation Improvements or additions to documentation label Jul 23, 2026
@github-actions

Copy link
Copy Markdown
Contributor

PR Summary

This PR enhances the workflow documentation by introducing a new trigger option, "On Field Change." The documentation now includes an additional bullet point under the workflow start section that describes how to initiate a workflow when a specific artifact field changes. Detailed guidance is provided on configuring this trigger, including selecting the field to monitor and clarifying that only artifact fields applicable to the chosen artifact type are available (while record fields from the parent record are excluded). Additional footnotes have been added for further clarification, ensuring users understand the implications when dealing with date or datetime fields.

Test Suggestions

  • Review the rendered documentation to ensure the new 'On Field Change' section is correctly formatted and clear.
  • Verify that the new footnotes and inline links (e.g., 'Manage artifact fields') are correctly linked and accessible.
  • Check consistency of the workflow trigger descriptions across different sections of the guide.

@cachafla
cachafla marked this pull request as ready for review July 23, 2026 22:10
@cachafla
cachafla requested a review from panchicore July 23, 2026 23:01

@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.

🌮 lgtm

@cachafla
cachafla enabled auto-merge July 23, 2026 23:14
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

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

@cachafla
cachafla added this pull request to the merge queue Jul 23, 2026
Merged via the queue into main with commit 259397f Jul 23, 2026
5 of 6 checks passed
@cachafla
cachafla deleted the codex/sc-16429-artifact-field-change-workflows branch July 23, 2026 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants