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.

Sign up for GitHub

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

Jump to bottom

🚀 Feature: Allow for overriding emails #542

Closed
3 tasks done
JoshuaKGoldberg opened this issue Jun 14, 2023 · 1 comment · Fixed by #858
Closed
3 tasks done

🚀 Feature: Allow for overriding emails #542

JoshuaKGoldberg opened this issue Jun 14, 2023 · 1 comment · Fixed by #858
Assignees
@JoshuaKGoldberg
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Milestone
Post-Rename Migra...

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Jun 14, 2023 •
edited
Loading

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

Right now, the owning user's email is referenced in the following locations within this template:

  • package.json's author.email
  • CODE_OF_CONDUCT.md
  • SECURITY.md

Most people are probably ok with having the same email used in all places. I personally prefer having a granular email for each location:

  • One for GitHub files, like github [at] joshuakgoldberg [dot] com
  • One for npm package.json, like npm [at] joshuakgoldberg [dot] com

In addition to the --email argument that exists today, I'd like to add optional --email-github and --email-npm args. That way people like me can add email overrides.

Additional Info

If --email-github and --email-npm are both provided, I suppose the --email field isn't necessary. So maybe let's have it so that you can use either --email_ or both of --email-github & --email-npm?

Repository hydration -which is what actually uses the email- is documented here: https://github.com/JoshuaKGoldberg/template-typescript-node-package#repository-hydration

Right now, --email is parsed here: https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/21f7303d813c2d5df18204e2e1b90ea9740e9ba8/src/shared/inputs.ts#L42
@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Jun 14, 2023
@JoshuaKGoldberg JoshuaKGoldberg added this to the Post-Rename Migration milestone Sep 4, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Sep 21, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Sep 21, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Sep 21, 2023
@JoshuaKGoldberg
feat: allow specific GitHub and/or npm emails (#858)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
d112a31 
## PR Checklist

- [x] Addresses an existing open issue: fixes #542
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Builds off the ideas in #851 by adding optional `--email-github` and
`--email-npm` overrides. Adds a string complaint if an improper
combination is specified: one of those two without the other or `email`,
or both of those two along with `email`. At this point `email` is now a
required option.

Adjusts the sorting of rerun suggestions a bit to make sure emails are
sorted inline and `--base` comes immediately after `--mode`.

Also fills in some unit test coverage in the area.
@github-actions
Copy link

github-actions bot commented Oct 2, 2023

🎉 This is included in version v1.32.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Projects
None yet
Milestone
Post-Rename Migration
Development

Successfully merging a pull request may close this issue.

feat: allow specific GitHub and/or npm emails JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg