Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
zeucapua opened this issue Sep 11, 2024 · 3 comments · Fixed by #214
Closed

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

zeucapua opened this issue Sep 11, 2024 · 3 comments · Fixed by #214

Comments

@zeucapua
Copy link
Contributor

zeucapua commented Sep 11, 2024

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 #137 (review)

Copy link
Contributor

open-sauced bot commented Oct 11, 2024

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

The release is available on:

Your semantic-release bot 📦🚀

Copy link
Contributor

open-sauced bot commented Oct 11, 2024

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

The release is available on:

Your semantic-release bot 📦🚀

Copy link
Contributor

open-sauced bot commented Oct 11, 2024

🎉 This issue has been resolved in version 2.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@open-sauced open-sauced bot added the released label Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant