open-sauced / pizza-cli

A CLI for all things OpenSauced
MIT License
39 stars 11 forks source link

Feature: comment preamble on generated `.sauced.yaml` configuration #170

Closed zeucapua closed 3 weeks ago

zeucapua commented 1 month ago

Suggested solution

Add the following preamble before the data in the .sauced.yaml file:

# Configuration for attributing commits with emails to GitHub user profiles
# Used during codeowners generation.

# List the emails associated with the given username
# The commits associated with these emails will be attributed to
# the username in this yaml map. Any number of emails may be listed

Context

Having an existing .sauced.yaml, it regenerated it, but the missing premable in comments got removed. Not sure if that's from our template, but just mentioning it.

When regenerating the .sauced.yaml, if one is detected (non-interactive mode) potentially mention it before they proceed.

Also, not sure how far back we're looking by default in the git history, but I see Anush, one of our interns in the list.

CleanShot 2024-09-10 at 13 50 41

Also, we should skip known bot accounts, i.e. any account ending in [bot].

Originally posted by @nickytonline in https://github.com/open-sauced/pizza-cli/pull/137#pullrequestreview-2293271309

open-sauced[bot] commented 3 weeks ago

:tada: This issue has been resolved in version 2.2.0-beta.4 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

open-sauced[bot] commented 3 weeks ago

:tada: This issue has been resolved in version 2.3.0-beta.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

open-sauced[bot] commented 3 weeks ago

:tada: This issue has been resolved in version 2.3.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: