open-sauced / pizza-cli

A CLI for all things OpenSauced
MIT License
33 stars 9 forks source link

Feature: Feedback - Offboarding experience with `pizza clean` or `pizza offboard` #117

Open jpmcb opened 3 weeks ago

jpmcb commented 3 weeks ago

Suggested solution

Some early feedback we've gotten has been around the "offboarding experience" as it relates to GitHub resources and generating codeowners files.

Scenario: let's say an engineering team on GitHub maintains the following sauced config file:

attribution:
  open-sauced/engineering:
    - john@email.domain
    - brandon@email.domain

Where commits authored by john and brandon get attributed to the @open-sauced/engineering GitHub team in the CODEOWNERS file.

Let's say that someone leaves the company and the file gets updated to:

attribution:
  open-sauced/engineering:
    - brandon@email.domain

Now, those (and future) commits authored by john won't appear as part of the @open-sauced/engineering team attribution in the CODEOWNERS.

But, there still may be issues assigned to john on GitHub or other resources (like the GitHub team) that john needs to get offboarded from. A subsequent pizza clean john@email.domain or pizza offboard ... command could be used to remove that user from those resources on GitHub.


We'd also want to think through this experience with users who are not operating on GitHub since the pizza generate codeowners command attempts to be as agnostic as possible.

zeucapua commented 4 days ago

Initial thoughts:

I'd like to try my hand creating the base command both automatic and interactive mode, where in both can have multiple users defined to remove on config and CODEOWNERS file! 🙋‍♀️