Skip to content

Latest commit

 

History

History
161 lines (127 loc) · 4.08 KB

onboarding-to-dashboard.md

File metadata and controls

161 lines (127 loc) · 4.08 KB

Steps to follow to onboard an action on the Health-Dashboard.

  1. Create set of labels

In the action repository, define the following labels:

Label Description Color (Optional)
need-to-triage Requires investigation #fbca04
idle Inactive for 14 days #9A777A
question Requiring some clarification #d876e3
bug Something is not working #d73a4a
P0 Action not working #B60205
P1 Some scenario broken but workaround exists #EE3D1D
enhancement Feature request/improved experience #a2eeef
documentation Improvements or additions to documentation #0075ca
backlog Planned for future #bd7e4b
performance-issue Performance improvement required #0e8a16
waiting-for-customer Waiting for inputs from customer #0e8a16

While triaging any issue, you can assign any of these labels to the issue, accordingly they will be reflected on the dashboard.

  1. Workflow for assigning default labels

Add a workflow file to create default labels to the action repository. If there are existing separate workflow files doing the same, they can be replaced by this workflow file.

  1. Adding Issue template

    For issues that will get created in the repo, the default label should be “need-to-triage”. This can be ensured using an issue template as follows :

  • On GitHub, navigate to the main page of the repository.

  • Under your repository name, click Settings. image

  • In the "Features" section, under "Issues," click Set up templates. image

  • Use the Add template drop-down menu, and click on the custom template. image

  • Specify the details, ensuring that label is set to “need-to-triage” image

  • Commit these changes.

  1. Giving permissions - Ignore for now

  2. Raise a PR in Actions Repo

In a single PR, you can do the following changes:

  • In the health-dashboard yml file, add the name of your action as orgName/actionName
    It has to be appended to the existing list of actions. image

  • In the issue-view yml file, add the following lines of code by replacing with your repo to the existing list of elements section image

  • In the pr-view yml file, add the following lines of code by replacing with your repo to the existing list of elements section.

image