-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Fabric Bot Services
Fabric Bot Services platform is being utilized throughout the Windows Community Toolkit repo to work as an automated bot and perform the tasks on behalf of users to increase productivity and ease the workflow.
You will see the Bot in action whether you open an Issue, PullRequest, Comment, label, etc
First, you will have to reach out to the team via email to request permission to be added in the repo that you are looking to automate.
Once the request is approved now you are able to customize the repo very easily in different ways.
Here is how our repo uses the Botπ€:
Auto-Merge label: This is the label that is used in active Pull Requests to give commands to signoff once all the requirements are met. (In our repo by default 2 reviewers need to sign-off and three checks including Toolkit/CI, WIP, and license/CLI need to be met. The wait time period for the PR is set for 8 hours since the time it was opened. Therefore once the 8 hours are complete and all the requirements are met, the PR will automatically be merged. If the 8 hours are not completed you will see the following message from @msftbot
"Hello user! Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.
p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here."
YOu can customize the auto-merge now by commanding the bot via comments. There are certain scenarios that can be used.
You can require limits of approval or a specific reviewer to proceed with the PR. For example: Merge this Pull request if approved by 3 reviewers or Only merge if "@user" approves the PR.
You can require approval from a few people to several people. For Example: Only merge the PR if @user1, @user2, and @user3 approve OR Merge the PR if @user1, @user1, or @user1 approves.
Additionally, you can also hold the PR for a certain time period. For example, Hold the PR for another 8 hours, etc.
You can customize the phrases the way you like and if the bot misinterpreted the phrase you mentioned feel free to say "Nevermind" and it will disregard the last change.
Replacing Needs Author Feedback label with Needs Attention: The purpose of both of these labels is to improve communication by triggering the labels to involve both the parties to make certain the issue or feature gets resolves in a timely manner. When the Issue or PR is received and the community member has questions they can comment which triggers the author's feedback label which creates visibility for the author to respond. The method can also be applied when the Author comments or response which triggers a Need Attention label for the community members to respond. This has been done by setting the following conditions:
The following conditions are used to perform certain tasks. Needs Triage is the most used label you will encounter throughout the reop. As the name suggests it used to triage the issue, feature, or any request whenever you open in the WCT. The purpose of the label is to create visibility ensure the opener that the issue has been received and from here it will be triaged to the appropriate team to ensure faster response and possible resolution. Event responder - issues Needs Triage label
Conditions | Actions |
---|---|
Condition: Is Action | Action: Opened |
Condition:
|
|
Condition:
|
|
Condition: Has Label | Label: bug π |
Actions | Triggers |
---|---|
Action: Add Label | Label: needs triage π |
Action: Add Reply | Label: I have automatically added a "needs triage" label to help get things started. Our team will analyze and investigate the issue, and escalate it to the relevant team if possible. Other community members may also look into the issue and provide feedback π |
|
The purpose of the following label is to ensure the continued momentum of the issue and to be certain there are no delays in responses from the party that is helping solve the problem. Therefore when the Author will comment on the issue @msftbot bot will automatically apply the "needs attention π" label to alert other parties to respond back to the author and expedite the issue. Event responder - issue comments Replace needs author feedback label with needs attention label when the author comments on an issue.
Conditions | Actions |
---|---|
Condition: Is Action | Action: Created |
Condition: Is Activity Sender | User: Author |
Condition: Has Label | Label: needs author feedback π |
Condition: Is Open |
Actions of the conditions applied above.
Actions | Triggers |
---|---|
Action: Add Label | Label: needs attention π |
Action: Remove Label | Label: needs author feedback π |
When the author will first open the feature request to introduce an idea or suggestions that can either improve the performance or innovate WCT, it will be responded back with the message by the bot that will greet and Add the Thumbs as a voting feature. Then the rest of the community will checkout the feature whether it's worth implementing in WCT or not. If they like the feature they will add more thumps up on top of the existing one to ensure the feature request must be adopted.
Event responder - issues Add Voting to New Feature Request
Conditions | Actions |
---|---|
Condition: Is action | Action: Opened |
Condition:
|
|
Condition:
|
|
Condition: Has Label | Label: feature request π« |
Actions | Actions |
---|---|
Action: Add Reaction | Reaction: π |
Action: Add reply | Reply: Hello, '${issueAuthor}! Thanks for submitting a new feature request. I've automatically added a vote π reaction to help get things started. Other community members can vote to help us prioritize this feature in the future! |
"No Recent Activity" label will ensure and alert the author with labels and messages that they have not responded to or performed any activity for 15 days. It will also provide warnings that the issue will be closed if it continued to be untouched or left without activity. The label provides greater visibility and triggers to make certain there are no delays. Scheduled search Add No Recent Activity label to issues
Conditions | Actions |
---|---|
Frequency:
|
|
Search term: Is issue | |
Search term: Is open | |
Search term: Has Label | Label: needs author feedback π |
Search term: No activity since | Days since last activity: 15 |
Search term: Does not have label | Label: no-recent-activity π |
Actions | Triggers |
---|---|
Action: Add Label | Label: no-recent-activity π |
Action: Add Reply | Reply: This issue has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 30 days of this comment. |
Once the comment has been made in the issue the "no-recent-activity π" will be removed. This ensures that the productivity of the issue will continue and proceeds towards possible solution of the problem. Event responder - issue comments Remove no recent label when an issue is commented on
Conditions | Actions |
---|---|
Condition: Has Label | Label: no-recent-activity π |
Actions | Triggers |
---|---|
Action: Remove Label | Label: no-recent-activity π |
"needs attention π" label with the message will be triggered to alert all the stakeholders that are involved in certain issues. This ensures transparency that the issue has been sitting without any activity for 15 days. Therefore it is essential to establish procedures that will either provide further guidance or triage the issue to the appropriate team that can resolve the issue in a timely manner.
Scheduled search Issues Needs Attention
Conditions | Actions |
---|---|
Frequency:
|
|
Search term: Is issue | |
Search term: Is open | |
Search term: Has Label | Label: needs triage π |
Search term: No activity since | Days since last activity: 15 |
Actions | Triggers |
---|---|
Action: Add Label | Label: needs attention π |
Action: Add Reply | Reply: This issue has been marked as "needs attention π" due to no activity for 15 days. Please triage the issue so the fix can be established. |
|
At this point after many alerts to the issue that required author feedback if still hasn't been responded @msftbot will the run the search based on these conditions and if any such issues are filtered it will respond the messaged regarding failure to respond to the issue and will automatically close the issue. Such actions are used to better manage the issue and to ensure the issues are just left open aren't cluttered in the repo and blocks the focus on issues that are active.
Scheduled search Closing Stale Issues
Conditions | Actions |
---|---|
Frequency:
|
|
Search term: Is issue | |
Search term: Is open | |
Search term: Has Label | Label: needs author feedback π |
Search term: Has Label | Label: no-recent-activity π |
Search term: No activity since | Days since last activity: 60 |
Actions | Triggers |
---|---|
Action: Add Reply | Reply: This issue has been automatically closed because it was marked as requiring author feedback but has not had any activity for over 60 days. |
Action: Close |
The conditions of this action runs regularly to ensure if there is an issue open with the Duplicate label, then @msftbot can respond to the issue with the message that the issue was open for 1 day and will be closed due to the fact it is a duplicate issue.
Closing Duplicate Issues
Conditions | Actions |
---|---|
Frequency:
|
|
Search term: Is issue | |
Search term: Is open | |
Search term: Has Label | Label: duplicate π₯ |
Search term: No activity since | Days since last activity: 1 |
Actions | Triggers |
---|---|
Action: Add Reply | Reply: This issue has been marked as duplicate and has not had any activity for 1 day. It will be closed for housekeeping purposes. |
Action: Close |
If an author responds to the issues that were closed earlier due to lack of participation or inactivity @msfbot will run the following conditions and see if it was within 7 days and if it fulfills all the requirement @msftbot will automatically reopen the issue and add the needs attention label to ascertain to provide a fresh start and possible resolution of the issue with the help of deleting any label such as no-recent-activity π and needs author feedback π to ensure issue looks clean and will be solved.
Event responder - issue comments Issues that are closed due to inactivity, reopens an issue if the author posts a reply within 7 days of the closing
Conditions | Actions |
---|---|
Condition:
|
|
Condition: Is action | Action: Created |
Condition: Has label | Label: needs author feedback π |
Condition: Has label | Label: no-recent-activity π |
Condition:
|
Days ago: 7 |
Condition:
|
|
Condition: Is activity sender | User: Author |
Condition:
|
Permissions: None |
Actions | Triggers |
---|---|
Action: Reopen issue | |
Action: Remove label | Label: no-recent-activity π |
Action: Remove label | Label: needs author feedback π |
Action: Add label | Label: needs attention π |
Issues that are closed with no activity for over 7 days, ask non-contributor to consider opening a new issue instead
Conditions | Actions |
---|---|
Condition: Is Action | Action: Created |
|
|
Condition: Activity Sender has permissions | Permissions: None |
Condition: No activity Since | Days ago: 7 |
Condition:
|
Actions |
---|
Action: Add reply |
Lock closed issues without activity for over 60 days
Conditions | Actions |
---|---|
Frequency:
|
|
Search term: Is closed | |
Search term: No activity since | Days since last activity: 60 |
Search term: Is unlocked | |
Search term: Is issue |
Actions | Triggers |
---|---|
Action: Add Label | Reason: Resolved |
Opening Pull Request
Conditions | Actions |
---|---|
Condition: Is Action | Action: Opened |
Actions | Triggers |
---|---|
Action: Add Reply | Reply: Thanks ${issueAuthor} for opening a Pull Request! The reviewers will test the PR and highlight if there is any conflict or changes required. If the PR is approved we will proceed to merge the pull request π |
Action: Request Reviewer | Reviewer: @user |
In-PR Label
Conditions | Actions |
---|---|
'In-PR' label: Label | |
Enable 'Fixed' Label? 'Fixed' Label: Label |
Add Needs Author feedback label to PR When Changes are Requested
Conditions | Actions |
---|---|
Condition: Is Action | Action: Submitted |
Condition: Is review state | State: Changed requested |
Actions | Triggers |
---|---|
Action: Add Label | Label: needs author feedback π |
Remove Needs Author Feedback Label when Author Responds
Conditions | Actions |
---|---|
Condition: Is activity sender | User: Author |
Condition:
|
Is action: Closed |
Condition: Has Label | Label: needs author feedback π |
Actions | Triggers |
---|---|
Action: Remove Label | Label: needs author feedback π |
Action: Add Label | Label: needs attention π |
Action: Add Reply | Reply: This PR has been marked as "needs attention π" and awaiting a response from the team. |
Remove No Recenet Activity from Pull Reqeuests
Conditions | Actions |
---|---|
Condition: Is Action | Action: Closed |
Condition: Has Label | Label: no-recent-activity π |
Actions | Triggers |
---|---|
Action: Remove Label | Label: no-recent-activity π |
Event responder Pull Request Comments Remove No Recent Activity when PR is commented ON
Conditions | Actions |
---|---|
Condition: Has Label | Label: no-recent-activity π |
Actions | Triggers |
---|---|
Action: Remove Label | Label: no-recent-activity π |
Event responder - pull request reviews Remove No Recent Activity when PR is reviewed
Conditions | Actions |
---|---|
Condition: Has Label | Label: no-recent-activity π |
Actions | Triggers |
---|---|
Action: Remove Label | Label: no-recent-activity π |
Scheduled search Close Stale PR
Conditions | Actions |
---|---|
Frequency:
|
|
Search term: Is pull request | |
Search term: Is open | |
Search term: Has Label | Label: needs author feedback π |
Search term: Has Label | Label: no-recent-activity π |
Search term: No activity since | Days since last activity: 45 |
Actions | Triggers |
---|---|
Action: Close |
Add No Recent Activity Label to the PR
Conditions | Actions |
---|---|
Frequency:
|
|
Search term: Is pull request | |
Search term: Is open | |
Search term: Has Label | Label: needs author feedback π |
Search term: No activity since | Days since last activity: 15 |
Search term: Does not have label | Label: no-recent-activity π |
Actions | Triggers |
---|---|
Action: Add Label | Label: no-recent-activity π |
Action: Add Reply | Reply: This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 30 days of this comment. |
If you have any feedback or questions regarding the fabric bot services please reach out to the team via email π
Fork the repo and Send the PR ππ
Any changes to the wiki made directly here on GitHub will be overwritten by the wiki repo commits
- Home π
- Welcome π
- Windows Community Toolkit π§°
- Features π¬
- Principles βοΈ
- Roadmap πΊ
- .NET Foundation
- Why Microsoft supports this project
- License π
- Sample App π±
- Getting Started π
- NuGet Packages π¦
- Preview Packages π
- Toolkit Labs π§ͺ
- Questions β
- Discussions π₯
- Submitting an Issue βοΈ
- Good First Issue π
- Help Wanted π
- Bug Fixes π
- Feature Requests π«
- Create and Submit PullRequest π
- Documentation π
- Review PR π
- Avoid Roadblocks π§
- Quick Start β‘
- Required Dependencies π
- Coding Style and Conventions β
- Testing π§ͺ
- Sample Development π±
- Accessibility Guideline βΏ
- Building XAML Controls π
- Fabric Bot Services π€
- CI and Infrastructure πΎ
- How the Project is Organized ποΈ
- Join the Toolkit Organization πͺ
- Hall of Fame π