Overview

As a developer for the website team, you are expected to follow the chain of complexity when you assign yourself an issue; that is, two good first issues, one small issue, one medium issue, and at least one large issue, although we make an exception to this progression for developers who apply both role: front end and role: back end/devOps labels on their prework issues. We want to create a GitHub Action that notifies a developer when they have assigned themselves to too many issues of a specified complexity.

Action Items

Currently, when a developer assigns themselves an issue, a GitHub Action runs that posts a comment on the issue:

Hi @developer, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

• Become familiar with HfLA's GitHub Actions
  • If you have not already done so, create a copy of the Project Board into your own repo (Tip 6: Creating your own Project Board)
  • Be sure to read up on using Personal Access Tokens to test the project board in your own repo (Tip 7: Using Personal Access Tokens to test in your own Project Board)
• Navigate to the add-preliminary-comment collection
• Add a new .md file named developer-complexity-reminder.md
• Copy the following text into the .md file

<!-- Template for a notification to the assignee that they've already worked on issue(s) of a certain complexity and they will be unassigned -->
Hello @${issueAssignee}, we appreciate you taking on issue ${issueNum}, however it looks like you've already worked on enough issues of this complexity. Try checking out some of the issues of the next complexity from the Prioritized Backlog :)

We are going to unassign you from this issue so you can take on another issue.

Hfla appreciates you! :)


P.S. There is one exception to this rule/automation, and that is if you were away for a long time, and need to do the issue ladder again.  If that is the case, please post the following note on the issue and on your prework.  A Merge team member will reassign you to this issue, and will help you get assigned to subsequent issues up to medium size.
```
I am returning after a significant time away, and need to do the issue ladder again. Please assign me back to this issue.
```

• Create the script that checks the developer's assigned issues in preliminary-update-comment.js
• Your script should check the following:
  • If the dev has assigned themself to a third good first issue
  • If the dev has assigned themself to a second Complexity: Small issue, except in the case where:
    • the developer's prework issue contains both role: front end and role: back end/devOps
    • AND the first Complexity: Small issue was either front end or backend/devOps (but not both)
    • AND the second Complexity: Small issue is either has both labels or the label that was not on the first Complexity: Small issue
  • If the dev has assigned themself to a second Complexity: Medium issue, except in the case where:
    • the developer's prework issue contains both role: front end and role: back end/devOps
    • AND the first Complexity: Medium issue was either front end or backend/devOps (but not both)
    • AND the second Complexity: Medium issue is either has both labels or the label that was not on the first Complexity: Medium issue
  • If any of the above checks have a true outcome, the template contained in developer-complexity-reminder.md should be used to post a comment in the issue, instead of the comment that asks the dev for their availabity
  • The script should also perform the following:
  • Post the same comment in the developer's prework issue
    • If the developer's prework issue is closed, reopen it
  • Unassign the dev from the issue
  • Add a ready for prioritization label
  • Move the issue to the New Issue Approval column
• Testing the new GHA in a copy of the Project Board in your repository
• Demonstrate your new GHA to the merge team

Resources/Instructions

• ER associated with this issue: ER from TLDL: GHA script to identify member's working on multiple same complexity issues #4193
• Never done GitHub actions? Start here!
• GitHub Complex Workflows doc
• GitHub Actions Workflow Directory
• Events that trigger workflows
• Workflow syntax for GitHub Actions
• actions/github-script
• GitHub RESTAPI
• HfLA GitHub Action workflows
• HfLA GitHub Action JavaScript files
• HfLA's GitHub Actions