Commit d1d7dbd9 authored by Bhushan Shah's avatar Bhushan Shah 📱

adjust formatting and make example rules part of README

parent dea356e0
......@@ -2,9 +2,7 @@
The following is a list of rules concerning the KDE Activity Filter Service which must be adhered to by all rules processed by the system.
For a list of example rules, please see https://invent.kde.org/sysadmin/repo-management/-/blob/master/activity-filter/example-rules.yaml
**Personal Rules**
## Personal Rules
These should be created in the personal/ folder, with one file for each person's own rules.
Each file should follow the user's username (eg: for scripty, it would be personal/scripty.yaml)
......@@ -14,7 +12,7 @@ For Gitlab, users should subscribe to the projects/groups they're interested in
While users are welcome to use alternative addresses (ones that are not their primary address) under no circumstances is for another person's address to be used in Activity Filter.
**Mailing List Rules**
## Mailing List Rules
As mailing lists have a substantial reach, with lists sometimes numbering in hundreds to thousands of subscribers, mailing lists may not be setup within Activity Filter without first getting the consent of the list in question.
......@@ -30,3 +28,36 @@ When committing these Activity Filter rules, a link to the mailing list archives
These rules should be committed to the lists/ folder, using the name of the mailing list (with the kde.org component removed) as the name of the file (eg: kde-frameworks-devel would be lists/kde-frameworks-devel.yaml)
For mailing lists, there are no limitations as to the rules that are setup, with rules able to be setup for Commits, Bugs and GitLab activity.
## Example rules
```yaml
- name: "Frameworks MR Notifications"
subscribes: "kde-frameworks-devel@kde.org"
to: merge_requests
where:
project: 'frameworks/.*'
- name: "Frameworks Task Notifications"
subscribes: "kde-frameworks-devel@kde.org"
to: tasks
where:
project: 'frameworks/.*'
- name: "KMyMoney Commits by Scripty"
subscribes: "kmymoney-commits@kde.org"
to: commits
where:
project: 'office/kmymoney'
branch: 'master'
author: 'scripty'
- name: "Marble Bugs List"
subscribes: "marble-bugs@kde.org"
to: bugs
where:
product: 'marble'
component: 'general'
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment