Skip to content

Commit

Permalink
Triage automation and documentation improvements (#763)
Browse files Browse the repository at this point in the history
  • Loading branch information
@matebarabas
matebarabas authored Mar 25, 2024
1 parent c903b7b commit a76a724
Show file tree
Hide file tree
Showing 4 changed files with 733 additions and 192 deletions.
166 changes: 104 additions & 62 deletions .github/policies/eventResponder.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,36 +10,54 @@ configuration:
- description: 'ITA06 - If a new issue or PR is opened add the "Needs: Triage :mag:" label'
if:
- or:
- payloadType: Issues
- payloadType: Pull_Request
- payloadType: Issues
- payloadType: Pull_Request
- isAction:
action: Opened
then:
- addLabel:
label: 'Needs: Triage :mag:'
label: "Needs: Triage :mag:"
- addReply:
reply: |
> [!IMPORTANT]
> **The "Needs: Triage :mag:" label must be removed once the triage process is complete !**
> [!TIP]
> For additional guidance on how to triage this issue/PR, see the [AVM Issue Triage](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/avm-issue-triage/) documentation.
> [!NOTE]
> This label was added as per [ITA06](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita06).
- description: 'ITA09 - When #RR is used in an issue, add the "Needs: Author Feedback :ear:" label'
if:
- or:
- payloadType: Pull_Request_Review_Comment
- payloadType: Issue_Comment
- commentContains:
pattern: '#RR'
pattern: "#RR"
then:
- addLabel:
label: 'Needs: Author Feedback :ear:'
label: "Needs: Author Feedback :ear:"
- addReply:
reply: |
> [!NOTE]
> The "Needs: Author Feedback :ear:" label was added as per [ITA09](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita09).
- description: 'ITA10 - When #wontfix is used in an issue, mark it by using the label of "Status: Won''t Fix :broken_heart:"'
if:
- or:
- payloadType: Pull_Request_Review_Comment
- payloadType: Issue_Comment
- commentContains:
pattern: '#wontfix'
pattern: "#wontfix"
then:
- addLabel:
label: 'Status: Won''t Fix :broken_heart:'
label: "Status: Won't Fix :broken_heart:"
- closeIssue
- addReply:
reply: |
> [!NOTE]
> The "Status: Won't Fix :broken_heart:" label was added and the issue was closed as per [ITA10](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita10).
- description: 'ITA11 - When a reply from anyone to an issue occurs, remove the "Needs: Author Feedback :ear:" label and label with "Needs: Attention :wave:"'
if:
Expand All @@ -50,20 +68,24 @@ configuration:
isAction:
action: Closed
- hasLabel:
label: 'Needs: Author Feedback :ear:'
label: "Needs: Author Feedback :ear:"
then:
- removeLabel:
label: 'Needs: Author Feedback :ear:'
label: "Needs: Author Feedback :ear:"
- addLabel:
label: 'Needs: Attention :wave:'
label: "Needs: Attention :wave:"
- addReply:
reply: |
> [!NOTE]
> The "Needs: Author Feedback :ear:" label was removed and the "Needs: Attention :wave:" label was added as per [ITA11](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita11).
- description: 'ITA12 - Clean email replies on every comment'
- description: "ITA12 - Clean email replies on every comment"
if:
- payloadType: Issue_Comment
then:
- cleanEmailReply

- description: 'ITA13 - If the language is set to Bicep in the Module proposal, assign the "Language: Bicep :muscle:" label on the issue'
- description: 'ITA13 - If the language is set to Bicep in the Module proposal, add the "Language: Bicep :muscle:" label on the issue'
if:
- payloadType: Issues
- isAction:
Expand All @@ -75,9 +97,13 @@ configuration:
Bicep
then:
- addLabel:
label: 'Language: Bicep :muscle:'
label: "Language: Bicep :muscle:"
- addReply:
reply: |
> [!NOTE]
> The "Language: Bicep :muscle:" label was added as per [ITA13](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita13).
- description: 'ITA14 - If the language is set to Terraform in the Module proposal, assign the "Language: Terraform :globe_with_meridians:" label on the issue'
- description: 'ITA14 - If the language is set to Terraform in the Module proposal, add the "Language: Terraform :globe_with_meridians:" label on the issue'
if:
- payloadType: Issues
- isAction:
Expand All @@ -89,35 +115,43 @@ configuration:
Terraform
then:
- addLabel:
label: 'Language: Terraform :globe_with_meridians:'
label: "Language: Terraform :globe_with_meridians:"
- addReply:
reply: |
> [!NOTE]
> The "Language: Terraform :globe_with_meridians:" label was added as per [ITA14](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita14).
- description: 'ITA15 - remove the "Needs: Triage" label from a PR, if it already has a "Type: XYZ" label assigned at the time of creating it.'
- description: 'ITA15 - remove the "Needs: Triage" label from a PR, if it already has a "Type: XYZ" label added at the time of creating it.'
if:
- payloadType: Pull_Request
- or:
- hasLabel:
label: 'Type: Bug :bug:'
- hasLabel:
label: 'Type: Documentation :page_facing_up:'
- hasLabel:
label: 'Type: Duplicate :palms_up_together:'
- hasLabel:
label: 'Type: Feature Request :heavy_plus_sign:'
- hasLabel:
label: 'Type: Hygiene :broom:'
- hasLabel:
label: 'Type: New Module Proposal :bulb:'
- hasLabel:
label: 'Type: Question/Feedback :raising_hand:'
- hasLabel:
label: 'Type: Security Bug :lock:'
- hasLabel:
label: 'Type: AVM :a: :v: :m:'
- hasLabel:
label: "Type: Bug :bug:"
- hasLabel:
label: "Type: Documentation :page_facing_up:"
- hasLabel:
label: "Type: Duplicate :palms_up_together:"
- hasLabel:
label: "Type: Feature Request :heavy_plus_sign:"
- hasLabel:
label: "Type: Hygiene :broom:"
- hasLabel:
label: "Type: New Module Proposal :bulb:"
- hasLabel:
label: "Type: Question/Feedback :raising_hand:"
- hasLabel:
label: "Type: Security Bug :lock:"
- hasLabel:
label: "Type: AVM :a: :v: :m:"
- isAction:
action: Opened
then:
- removeLabel:
label: 'Needs: Triage :mag:'
label: "Needs: Triage :mag:"
- addReply:
reply: |
> [!NOTE]
> The "Needs: Triage :mag:" label was removed as per [ITA15](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita15).
- description: 'ITA16 - Add the "Status: Owners Identified :metal:" label when someone is assigned to a Module Proposal'
if:
Expand All @@ -126,14 +160,18 @@ configuration:
isAction:
action: Closed
- hasLabel:
label: 'Type: New Module Proposal :bulb:'
label: "Type: New Module Proposal :bulb:"
- isAssignedToSomeone
then:
- addLabel:
label: 'Status: Owners Identified :metal:'
label: "Status: Owners Identified :metal:"
- addReply:
reply: |
> [!NOTE]
> The "Status: Owners Identified :metal:" label was added as per [ITA15](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita15).
triggerOnOwnActions: true

- description: 'ITA17A - If the issue author says they want to be the module owner, assign the issue to the author and respond to them.'
- description: "ITA17 - If the issue author says they want to be the module owner, assign the issue to the author and respond to them."
if:
- payloadType: Issues
- isAction:
Expand All @@ -146,27 +184,19 @@ configuration:
then:
- assignTo:
author: true

- description: 'ITA17B - If the issue author says they want to be the module owner, assign the issue to the author and respond to them.'
if:
- payloadType: Issues
- isAction:
action: Opened
- bodyContains:
pattern: |
### Do you want to be the owner of this module?
Yes
then:
- addReply:
reply: |
@${issueAuthor}, thanks for volunteering to be a module owner!
**Please don't start the development just yet!**
> [!IMPORTANT]
> **Please don't start the development just yet!**
>
> The AVM core team will review this module proposal and respond to you first. Thank you!
The AVM core team will review this module proposal and respond to you first. Thank you!
> [!NOTE]
> This message was posted as per [ITA17](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita17).
- description: 'ITA18 - Send automatic response to the issue author if they don''t want to be module owner and don''t have any candidate in mind. Assign the "Needs: Module Owner :mega:" label.'
- description: 'ITA18 - Send automatic response to the issue author if they don''t want to be module owner and don''t have any candidate in mind. Add the "Needs: Module Owner :mega:" label.'
if:
- payloadType: Issues
- isAction:
Expand All @@ -182,14 +212,18 @@ configuration:
_No response_
then:
- addLabel:
label: 'Needs: Module Owner :mega:'
label: "Needs: Module Owner :mega:"
- addReply:
reply: |
@${issueAuthor}, thanks for submitting this module proposal!
**@${issueAuthor}, thanks for submitting this module proposal!**
> [!IMPORTANT]
> The AVM core team will review it and will try to find a module owner.
The AVM core team will review it and will try to find a module owner.
> [!NOTE]
> This message was posted as per [ITA18](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita18).
- description: 'ITA19 - Send automatic response to the issue author if they don''t want to be module owner but have a candidate in mind. Assign the "Status: Owners Identified :metal:" label.'
- description: 'ITA19 - Send automatic response to the issue author if they don''t want to be module owner but have a candidate in mind. Add the "Status: Owners Identified :metal:" label.'
if:
- payloadType: Issues
- isAction:
Expand All @@ -207,14 +241,18 @@ configuration:
_No response_
then:
- addLabel:
label: 'Status: Owners Identified :metal:'
label: "Status: Owners Identified :metal:"
- addReply:
reply: |
@${issueAuthor}, thanks for submitting this module proposal with a module owner in mind!
**@${issueAuthor}, thanks for submitting this module proposal with a module owner in mind!**
**Please don't start the development just yet!**
> [!IMPORTANT]
> **Please don't start the development just yet!**
>
> The AVM core team will review this module proposal and respond to you and/or the module owner first. Thank you!
The AVM core team will review this module proposal and respond to you and/or the module owner first. Thank you!
> [!NOTE]
> This message was posted as per [ITA19](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita19).
- description: 'ITA23 - Remove the "Status: In PR" label from an issue when it''s closed.'
if:
Expand All @@ -223,4 +261,8 @@ configuration:
action: Closed
then:
- removeLabel:
label: 'Status: In PR :point_right:'
label: "Status: In PR :point_right:"
- addReply:
reply: |
> [!NOTE]
> The "Status: In PR :point_right:" label was removed as per [ITA23](https://azure.github.io/Azure-Verified-Modules/help-support/issue-triage/issue-triage-automation/#ita23).
Loading

0 comments on commit a76a724

Please sign in to comment.