grafana/sigma-rule-deployment

Further improve comment formatting

Open

#241 opened on Nov 13, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (0 forks)auto 404
deployergood first issue

Repository metrics

Stars
 (15 stars)
PR merge metrics
 (PR metrics pending)

Description

Story (Outcome/Output) (Required)

To help users comprehend the comments produced by SRD, we should update the comment produced by the deploy action to use rule titles, and sort all rule titles alphabetically to assist in identifying them quickly.

Context

In #218 we improved the display of SRD comments regarding conversions and integrations, replacing paths with comment titles, but the same change wasn't made for the deploy comment.

Definition of Done (Required)

All deployment comments use the title of the deployed rule instead of the ID, and all comment titles are sorted alphabetically.

Dependencies (Required)

None

Contributor guide

Research direction
Examine the deploy comment generation code and apply the same pattern used in PR #218 for conversions and integrations comments, ensuring rule titles are used and sorted alphabetically.
Tech stack
go
Domain
backenddevops
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60