Skip to content

docs: add descriptive step names to all example workflows#17

Merged
clouatre merged 1 commit intomainfrom
docs/add-step-names-to-examples
Nov 16, 2025
Merged

docs: add descriptive step names to all example workflows#17
clouatre merged 1 commit intomainfrom
docs/add-step-names-to-examples

Conversation

@clouatre
Copy link
Copy Markdown
Member

Summary

Adds descriptive step names to all example workflows for improved clarity and readability.

Changes

Added step names to all 3 example files:

tier1-maximum-security.yml (3 names)

  • name: Checkout
  • name: Setup Goose CLI
  • name: Upload Analysis Artifact

tier2-balanced-security.yml (5 names)

  • name: Checkout
  • name: Setup Goose CLI
  • name: Upload Review Artifact
  • name: Download Review Artifact
  • name: Post Review Comment

tier3-advanced-patterns.yml (3 names)

  • name: Checkout
  • name: Setup Goose CLI
  • name: Upload Review Artifact

Why

  • Improves readability and debugging experience
  • Aligns with README Quick Start naming conventions
  • Makes examples more educational and easier to follow
  • Consistent naming across all examples

Testing

  • ✅ Verified YAML syntax is valid
  • ✅ Step names align with README patterns
  • ✅ No functional changes, only naming improvements

@clouatre clouatre merged commit 2018e1f into main Nov 16, 2025
5 checks passed
@clouatre clouatre deleted the docs/add-step-names-to-examples branch November 16, 2025 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant