GitHub Actions: Automatic response to feature branch issues

[Aveline-art]

Overview

We need to create a GHA to post a comment on any issue that gets a label feature: feature branch with details about what the developer should do. If the label gets removed, the message should be removed. This should be a new job that runs in parallel with the other jobs under the "Issue Trigger" action.

Action Items

• Trigger: On event issues: activity opened if the issue has the feature: feature branch OR activity labeled with the label feature: feature branch
  • Add a comment to the issue:

Hi @[REPLACE WITH AUTHOR]
Based on the `feature: feature branch` label, this issue should target a feature branch.  Please consult the instructions on [working off of a feature branch](https://github.com/hackforla/website/wiki/How-to-work-off-of-a-feature-branch)

• Trigger: On event issues: activity unlabeled - if the label feature: feature branch is removed
  • Hide (as "outdated") the comment described above

Checks

• When the feature: feature branch label is added during issue creation, the comment is added
• When the feature: feature branch label is applied after issue creation, the comment is added
• When a different label is added during issue creation, the additional text is not added.
• When the feature: feature branch label is removed, the comment is hidden
• When a different label is removed, the comment is not hidden

Resources/Instructions

Never done GitHub actions? Start here!

Note that you might want to do something outside the scope of the above psudo-code. If so, be sure to leave comments in your PR or this issue that justifies your reasoning. If you feel you need guidance, be sure to reach out! We cannot foresee whether this issue is solvable, or what hard decisions have to be made, but we would love to hear and help you!

Additional resources:

Events that trigger workflows
Workflow syntax for GitHub Actions
actions/github-script
GitHub RESTAPI
GitHub GraphQL
Bonnie test text to remove
Bonnie second test

[ExperimentsInHonesty]

This is an old comment and is being left so that if anyone wants to know the history, they can look at it. But the instructions in the top are the most current instructions.

@Aveline-art @Zak234 were discussing this issue. And we have completed this feasibility review. See additional notes at bottom as well. Please decide if you want this issue to go forward and how.

Feasibility Review

• When the "Feature Branch" label is added during issue creation, the additional text is added.

• Feasibility: Low for adding things to the top comment on an issue by adding label, not by editing because github does not the top portion of an issue (where original issue is described) as a comment

  • Example:
    this link is the top of this issue GitHub Actions: Automatic response to feature branch issues #1940 (comment)
    this link is the comment prior to this one: GitHub Actions: Automatic response to feature branch issues #1940 (comment)
    You can see that one has the word comment and the does not.

• Alternative is setting up a different template that automatically has instructions and adds the label.

• When a different label is added during issue creation, the additional text is not added.
  Feasibility: high

• When the "Feature Branch" label is added after issue creation, the additional text is added.

• Feasibility: Low for adding things to the top comment on an issue by adding label, not by editing because github does not the top portion of an issue (where original issue is described) as a comment

  • Example:
    this link is the top of this issue GitHub Actions: Automatic response to feature branch issues #1940 (comment)
    this link is the comment prior to this one: GitHub Actions: Automatic response to feature branch issues #1940 (comment)
    You can see that one has the word comment and the does not.

• Alternative is adding it to a comment

• When a different label is added after issue creation, the additional text is not added.

  • Feasibility: high

• When the "Feature Branch" label is removed, the additional text is removed.

  • Feasibility: Low if its part of the top portion
  • Feasibility: High if it is its own comment

Additional options fpr research

When a person open a pr, it could check to see if the issue mentioned has a feature branch label and if it does it could look at the other feature label to see what the feature branch should be called and it could check to see if the commit was made to that branch name. and if it was not it could give an automated response to the person telling them to remove the pr and submit on the correct branch. This would require us naming feature branches with the exact name of the feature label.

[github-actions]

Hi @partapparam, 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 :)

[partapparam]

i. Availability: 6-9pm Wed and Thursday. 12-6 pm Sunday.
ii. ETA: 4/26

[ExperimentsInHonesty]

@partapparam I will move this issue the in progress column, but in future, you should do that when you self assign.

[partapparam]

whoops, sorry. thanks @ExperimentsInHonesty

[partapparam]

Update
i. Availability: 3-6pm Friday, 9-3pm Sat.
ii. ETA: 4/27