Skip to content

Commit

Permalink
Fix documentation related to configuration of labels
Browse files Browse the repository at this point in the history
  • Loading branch information
yrodiere committed Dec 12, 2024
1 parent 0b7abd7 commit 062b95e
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,6 @@ participants:
maxIssues: 2
stale:
maxIssues: 5
ignoreLabels: ["triage/on-ice"]
----

`labels`::
Expand All @@ -198,11 +197,6 @@ How many issues, at most, you wish to be included in the "Stale" category
for each notification.
+
Integer, mandatory, no default.
`stale.ignoreLabels`::
The labels identifying issues that should be ignored for the "Stale" category.
Issues mentioned in notifications will never have any one of these labels.
+
Array of Strings, optional, defaults to an empty array.

[[participants-stewardship]]
=== Stewardship
Expand Down Expand Up @@ -231,7 +225,6 @@ participants:
stewardship:
days: ["MONDAY"]
maxIssues: 5
ignoreLabels: ["triage/on-ice"]
----

`days`::
Expand All @@ -243,11 +236,6 @@ How many issues, at most, you wish to be included in the "stewardship" category
for each notification.
+
Integer, mandatory, no default.
`ignoreLabels`::
The labels identifying issues that should be ignored for the "stewardship" category.
Issues mentioned in notifications will never have any one of these labels.
+
Array of Strings, optional, defaults to an empty array.

[[participants-suspending]]
=== Suspending notifications
Expand Down Expand Up @@ -304,7 +292,7 @@ buckets:
timeout: P3D
maintenance:
feedback:
label: "triage/needs-reproducer"
labels: ["triage/needs-reproducer"]
needed:
delay: P21D
timeout: P3D
Expand All @@ -314,9 +302,11 @@ buckets:
stale:
delay: P60D
timeout: P14D
ignoreLabels: ["triage/on-ice"]
stewardship:
delay: P60D
timeout: P14D
ignoreLabels: ["triage/on-ice"]
# [...]
----

Expand All @@ -338,10 +328,10 @@ How much time to wait after an issue was last notified about
before including it again in the lottery in the "triage" bucket.
+
String in https://en.wikipedia.org/wiki/ISO_8601#Durations[ISO-8601 duration format], mandatory, no default.
`buckets.maintenance.feedback.label`::
The label identifying GitHub issues for which feedback (a reproducer, more information, ...) was requested.
`buckets.maintenance.feedback.labels`::
The labels identifying GitHub issues for which feedback (a reproducer, more information, ...) was requested.
+
String, mandatory, no default.
Array of strings, mandatory, no default.
`buckets.maintenance.feedback.needed.delay`::
How much time to wait after the last update on an issue
before including it in the lottery in the "feedback needed" bucket.
Expand All @@ -367,6 +357,11 @@ How much time to wait after the last update on an issue
before including it in the lottery in the "stale" bucket.
+
String in https://en.wikipedia.org/wiki/ISO_8601#Durations[ISO-8601 duration format], mandatory, no default.
`buckets.maintenance.stale.ignoreLabels`::
The labels identifying GitHub issues that should be ignored for the "stale" bucket.
Issues with one of these labels will never be added to the bucket.
+
Array of Strings, optional, defaults to an empty array.
`buckets.maintenance.stale.timeout`::
How much time to wait after an issue was last notified about
before including it again in the lottery in the "stale" bucket.
Expand All @@ -382,6 +377,11 @@ How much time to wait after an issue was last notified about
before including it again in the lottery in the "stewardship" bucket.
+
String in https://en.wikipedia.org/wiki/ISO_8601#Durations[ISO-8601 duration format], mandatory, no default.
`buckets.stewardship.ignoreLabels`::
The labels identifying GitHub issues that should be ignored for the "stewardship" bucket.
Issues with one of these labels will never be added to the bucket.
+
Array of Strings, optional, defaults to an empty array.

[[config-validation]]
=== Validation of the configuration
Expand Down

0 comments on commit 062b95e

Please sign in to comment.