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

feat: add comment preamble to generated config #214

Merged
merged 2 commits into from
Oct 11, 2024

Conversation

zeucapua
Copy link
Contributor

Description

Adds the following comments to the generated .sauced.yaml file made with the pizza generate config command:

# 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

Related Tickets & Documents

Closes #170

Mobile & Desktop Screenshots/Recordings

Steps to QA

  1. Build the CLI
  2. Run pizza generate config
  3. Read the generated .sauced.yaml file and see the added comments at the start

Tier (staff will fill in)

  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4

[optional] What gif best describes this PR or how it makes you feel?

@zeucapua zeucapua requested a review from a team October 10, 2024 18:39
@jpmcb jpmcb merged commit deb22a2 into beta Oct 11, 2024
6 checks passed
@jpmcb jpmcb deleted the feat/generate-config-preamble branch October 11, 2024 14:38
open-sauced bot pushed a commit that referenced this pull request Oct 11, 2024
## [2.2.0-beta.4](v2.2.0-beta.3...v2.2.0-beta.4) (2024-10-11)

### 🍕 Features

* add comment preamble to generated config ([#214](#214)) ([deb22a2](deb22a2))
open-sauced bot pushed a commit that referenced this pull request Oct 11, 2024
## [2.3.0-beta.1](v2.2.0...v2.3.0-beta.1) (2024-10-11)

### 🍕 Features

* add comment preamble to generated config ([#214](#214)) ([deb22a2](deb22a2))
* Add quick start section ([#203](#203)) ([eec884b](eec884b))
open-sauced bot pushed a commit that referenced this pull request Oct 11, 2024
## [2.3.0](v2.2.0...v2.3.0) (2024-10-11)

### 🍕 Features

* add comment preamble to generated config ([#214](#214)) ([deb22a2](deb22a2))
* Add quick start section ([#203](#203)) ([eec884b](eec884b))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: comment preamble on generated .sauced.yaml configuration
3 participants