Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔔 Notify Slack on CI Failures #1578

Open
11 tasks
jasonBirchall opened this issue Jan 20, 2025 · 0 comments
Open
11 tasks

🔔 Notify Slack on CI Failures #1578

jasonBirchall opened this issue Jan 20, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@jasonBirchall
Copy link
Collaborator

User Need

As a developer on an app team
I want CI failures to trigger notifications to a specified Slack channel
so that my team is promptly informed and can address issues quickly.

Value

  • Reduces time to detect and address CI pipeline failures.
  • Increases visibility of CI pipeline status across teams.
  • Minimises the risk of ignoring CI failures, improving overall software quality and reliability.

Functional Requirements (What):

  • Create a custom GitHub Action that triggers on CI pipeline failure.
  • Add functionality to specify a Slack channel for notifications.
  • Please make sure the message includes relevant details about the failure, such as the repository name, branch, and error logs.

Non-Functional Requirements (How):

  • Notifications should be sent within 30 seconds of a CI failure.
  • Use secure methods for storing and handling Slack Webhook URLs.
  • Ensure the custom GitHub Action is reusable and documented for other projects.
  • Notifications should follow a consistent and readable format.

Acceptance Criteria:

  • When a CI failure occurs, a message is sent to the specified Slack channel.
  • The message contains the repository name, branch, and failure summary.
  • The solution is tested and works for multiple Slack channels in different configurations.
  • Documentation is provided for setting up the custom GitHub Action in other repositories.

Assumptions (Optional):

  • The team has access to the necessary permissions to set up and use Slack Webhook URLs.
  • The CI pipelines are managed using GitHub Actions.
  • Users have existing Slack channels dedicated to CI/CD alerts or can create new ones.

Notes:

  • Currently, only deployment alerts are routed to #govuk-deploy-alerts, which covers the CD portion. This feature will extend similar visibility to the CI portion of pipelines to specific user channels.
  • Here is the conversation that started this request.
@jasonBirchall jasonBirchall added the enhancement New feature or request label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant