Skip to content

docs: update Quick Start with clearer security warning and named steps#15

Merged
clouatre merged 1 commit intomainfrom
docs/update-quick-start-security
Nov 16, 2025
Merged

docs: update Quick Start with clearer security warning and named steps#15
clouatre merged 1 commit intomainfrom
docs/update-quick-start-security

Conversation

@clouatre
Copy link
Copy Markdown
Member

Summary

Updates Quick Start section with clearer security messaging and descriptive step names.

Changes

  • Alert type: Changed from [!WARNING] to [!IMPORTANT] (more appropriate severity)
  • Security message: Clarified that prompt injection is a general AI risk, not specific to Goose or this action
  • Step names: Added descriptive names to all steps (Checkout, Setup Goose CLI, Upload Analysis Artifact)
  • Consistency: Matches pattern from setup-q-cli-action PR chore: bump actions/checkout from 4 to 5 #13

Why

  • [!IMPORTANT] is more appropriate than [!WARNING] for guidance/best practices
  • Expanded message helps users understand the risk applies to ANY AI tool
  • Named steps improve workflow readability and debugging
  • Example already uses safe pattern (tool output analysis)

Testing

  • ✅ Verified markdown renders correctly
  • ✅ All step names descriptive and consistent

@clouatre clouatre merged commit 32d19b5 into main Nov 16, 2025
4 checks passed
@clouatre clouatre deleted the docs/update-quick-start-security branch November 16, 2025 19:06
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