[Offboarding] Feedback for Slack 'user removal request' when GHA does not run correctly

mchelen-gov commented 3 years ago

Description

Users can notify Slack admins about account deactivation requests by commenting /request Firstname Lastname on offboarding tickets. There may have been some cases where the GHA did not run correctly, but there is no information included on the Github issue to know whether the action ran successfully or not.

This action only runs if the person who runs /request has 'write' permissions on the repository. If they do not, nothing will happen. What would need to happen here is to add a job in the action which checks the user's permissions previous to running the https://github.com/xt0rted/slash-command-action action and notifies the user that nothing will be done with their request.

TL;DR There are certain groups of people that do not receive a confirmation when they initiate an offboarding request.

Background/context

GHA action: https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/.github/workflows/slackRemovalRequest.yml
Private slack channel: https://dsva.slack.com/archives/G01E8353TKJ

Technical notes

Tasks

[ ] Update GHA to post comment

Acceptance Criteria

[ ] When action runs, if the user does not have write permissions to the va.gov-team repo, they are notified in the issue thread that the action did not run.
[ ] When action runs, if the request was successfully submitted to Slack, the bot leaves a comment in the GH issue.

Reminders

[ ] Please attach your team label and any other appropriate label(s) (operations, devops, and needs-grooming will automatically be applied as part of the template)
[ ] Please connect to an epic (this will typically be done by the Platform Operations PM or TL)

rmtolmach commented 2 years ago

Another time I've seen the action not run is when the /request command is surrounded with backticks so it looks like this: /request John Smith. I can tell it doesn't run because the :eyes: don't appear as a reaction.

mchelen-gov commented 2 years ago

Another time I've seen the action not run is when the /request command is surrounded with backticks so it looks like this: /request John Smith. I can tell it doesn't run because the :eyes: don't appear as a reaction.

Interesting, this feedback should probably be done as a comment for clarity sake.

oseasmoran73 commented 2 years ago

Here is an example of an action that failed due to one of previously linked off-board action

One thing that was discussed is potentially adding a notification if action failed as extra guard rails

rmtolmach commented 2 years ago

(Jeremy found this) A slack alert on failure can be done with something like this: https://github.com/department-of-veterans-affairs/devops/blob/master/.github/workflows/packer-build-eks.yml#L99-L107

rmtolmach commented 2 years ago

I haven't worked with GitHub Actions much yet, so I'd like to claim this ticket :hand:. Leaving in backlog until prioritized by leads/management.

oseasmoran73 commented 2 years ago

Move towards ready to do column as I suspect it is a low hanging fruit that can be picked up when on-call

department-of-veterans-affairs / va.gov-team