Skip to content

Commit

Permalink
Document how to configure Fedora Notifications (#988)
Browse files Browse the repository at this point in the history
Document how to configure Fedora Notifications

Fixes #977

Reviewed-by: František Lachman <[email protected]>
Reviewed-by: Matej Focko
  • Loading branch information
softwarefactory-project-zuul[bot] authored Jan 14, 2025
2 parents ad6021a + 40afe56 commit beea80e
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/fedora-releases-guide/dist-git-onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,9 @@ You can check all the job runs with details and logs in [Packit dashboard](https
- [koji_build](https://dashboard.packit.dev/jobs/downstream-koji-builds)
- [bodhi_update](https://dashboard.packit.dev/jobs/bodhi-updates)

You can utilise [Fedora Notifications](https://notifications.fedoraproject.org/) as well.
We also recommend utilising [Fedora Notifications](https://notifications.fedoraproject.org/)
since Fedora services do not notify package maintainers about activities triggered by others (i.e. Packit).
Learn more about setting it up [here](fedora-notifications.md).

### Notifications about errors
Since it is not possible to create issues in dist-git repositories, you can configure a repository where we should
Expand Down
31 changes: 31 additions & 0 deletions docs/fedora-releases-guide/fedora-notifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Configuring Fedora Notifications
sidebar_position: 8
---
To stay informed about Packit-triggered activities in the Fedora ecosystem,
you can use [Fedora Notifications](https://notifications.fedoraproject.org).

## Setting up
1. Go to https://notifications.fedoraproject.org/rules/new to create a new notification rule.
2. To be notified about package-related activities where you are an admin, configure the settings as shown
below (replace the username with your Fedora username):
![Fedora Notifications configuration 1](../img/fedora-releases-guide/fedora-notifications-1.png)

3. Click on `Add destination`:
- Choose your preferred notification method, such as email or Matrix handle (you might need to add them first in your account settings).
- Select services for which you want to be notified; for the Packit-related activities:
- `distgit` - information related to `pull_from_upstream`/`propose_downstream` job
- `Koji` - information related to `koji_build` job
- `bodhi` - information related to `bodhi_update` job
- Optionally, customise the topics from the Fedora messaging bus to focus on specific events.
You can see the list of topics [here](https://fedora-fedmsg.readthedocs.io/en/latest/topics.html).

Your setup might look something like this:
![Fedora Notifications configuration 2](../img/fedora-releases-guide/fedora-notifications-2.png)

4. Save the rule by clicking on `Create rule`.

Once set up, you will receive emails like this:
![Fedora Notifications email](../img/fedora-releases-guide/fedora-notifications-3.png)

You can adjust this rule anytime to match your preferences.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit beea80e

Please sign in to comment.