Skip to content

Conversation

@nathro
Copy link
Collaborator

@nathro nathro commented Aug 6, 2025

Handle multi-line custom guidelines in Describe PR action

Jira: [ENG-XXXX]

Summary

Add support for passing and safely parsing multi-line custom guidelines from the workflow into the action's context used for PR description generation. This makes the Describe PR action robust when teams provide project-specific guidance.

Changes

  • Workflow (.github/workflows/describe-pr.yml): Provide a multiline custom_guidelines example to the action, demonstrating typical project rules (e.g., Jira references, migrations/backfills highlighting).
  • Action (action.yml): Write the context output using the multiline GITHUB_OUTPUT syntax (<<EOF) so JSON from jq that includes newlines is preserved when CUSTOM_GUIDELINES is set; otherwise default to {}.

Impact

  • Ensures custom, multi-line guidelines are reliably delivered to the action without truncation or JSON parsing issues.
  • Enables stronger, project-specific PR descriptions (e.g., enforcing Jira references and calling out migrations/backfills).
  • No breaking changes and no new dependencies.

Database Migrations

  • None

Backfills

  • None

🤖 This description was generated automatically. Please react with 👍 if it's helpful or 👎 if it needs improvement.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Review completed. No suggestions at this time.

@nathro nathro requested a review from mtpauly August 6, 2025 15:51
@nathro nathro merged commit 69821ea into main Aug 6, 2025
1 check passed
@nathro nathro deleted the nathro_handle_multiline_custom_guidelines branch August 6, 2025 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants