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 --guide options #983

Merged
merged 6 commits into from
Oct 26, 2023
Merged

feat: add --guide options #983

merged 6 commits into from
Oct 26, 2023

Conversation

JoshuaKGoldberg
Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg commented Oct 25, 2023

PR Checklist

Overview

Adds --guide with the accompanying --guide-title, similar to the existing --logo and --logo-alt options. It will be inferred from an existing .github/DEVELOPMENT.md when present.

@codecov
Copy link

codecov bot commented Oct 25, 2023

Codecov Report

Merging #983 (c5c4afe) into main (88f87b1) will increase coverage by 0.10%.
The diff coverage is 91.17%.

@@            Coverage Diff             @@
##             main     #983      +/-   ##
==========================================
+ Coverage   93.47%   93.57%   +0.10%     
==========================================
  Files          91       92       +1     
  Lines        4860     4921      +61     
  Branches      403      413      +10     
==========================================
+ Hits         4543     4605      +62     
+ Misses        316      315       -1     
  Partials        1        1              
Flag Coverage Δ
create 70.99% <66.12%> (-0.11%) ⬇️
initialize 38.48% <58.06%> (+0.18%) ⬆️
migrate 69.86% <66.12%> (-0.10%) ⬇️
unit 68.57% <91.17%> (+0.43%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/create/createRerunSuggestion.ts 100.00% <100.00%> (ø)
src/shared/options/args.ts 100.00% <100.00%> (ø)
src/shared/options/createOptionDefaults/index.ts 100.00% <100.00%> (ø)
...reateOptionDefaults/readDefaultsFromDevelopment.ts 100.00% <100.00%> (ø)
src/shared/options/optionsSchema.ts 100.00% <100.00%> (ø)
src/shared/options/readOptions.ts 97.50% <100.00%> (+3.35%) ⬆️
...ps/writing/creation/dotGitHub/createDevelopment.ts 100.00% <100.00%> (ø)
src/shared/types.ts 0.00% <0.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review October 26, 2023 10:02
@JoshuaKGoldberg JoshuaKGoldberg merged commit 7f1350e into main Oct 26, 2023
15 of 16 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the guide-options branch October 26, 2023 10:13
@github-actions
Copy link

🎉 This is included in version v1.40.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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🚀 Feature: Add a --guide option for including a contributing walkthrough
1 participant