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: Split contributors option into exclusion and API skipping #898

Closed
3 tasks done
JoshuaKGoldberg opened this issue Sep 29, 2023 · 1 comment · Fixed by #899
Closed
3 tasks done

🚀 Feature: Split contributors option into exclusion and API skipping #898

JoshuaKGoldberg opened this issue Sep 29, 2023 · 1 comment · Fixed by #899
Assignees
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request

Comments

@JoshuaKGoldberg
Copy link
Owner

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 excludeContributors option has two purposes:

  • Primary: Avoid including all-contributors as a tooling piece
  • Secondary: As a part of ☝️, don't call to APIs to populate contributor data

I'd like to split the option into two: one for each of those two pieces. That way you can still include allcontributors as a tooling piece but also skip the API.

This will help with #878 / #879. Running in --offline shouldn't make it impossible to set up allcontributors in a repo.

Additional Info

No response

@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Sep 29, 2023
@JoshuaKGoldberg JoshuaKGoldberg added this to the Post-Rename Migration milestone Sep 29, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Sep 29, 2023
JoshuaKGoldberg added a commit that referenced this issue Sep 29, 2023
…kip-all-contributors-api (#899)

## PR Checklist

- [x] Addresses an existing open issue: fixes #875; fixes #898
- [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

Splits the option into:

* `--exclude-all-contributors`: disables the all-contributors feature
altogether
* `--skip-all-contributors-api`: allows the all-contributors feature,
but skips fetching past contributions from GitHub
@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
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Projects
None yet
1 participant