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: reworked setup flow and renamed to "initialization" and "migration" #668

Merged
merged 10 commits into from
Aug 21, 2023

Conversation

JoshuaKGoldberg
Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg commented Aug 21, 2023

PR Checklist

Overview

  • Renames the existing scripts and refers to them under the umbrella term of "setup":
    • "Hydration": is now called "migration"
    • "Setup": is now called "initialization"
  • Splits their usage docs into ./docs/*.md files, with more explanations of what they do

JoshuaKGoldberg added a commit that referenced this pull request Aug 21, 2023
## PR Checklist

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

## Overview

Changes split out of #668:

* If `git status` fails, runs `git init` to make the directory a repo
* Allows `package.json` to be empty, defaulting its contents to `{}`
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review August 21, 2023 23:35
@codecov
Copy link

codecov bot commented Aug 21, 2023

Codecov Report

Merging #668 (2e58e10) into main (7cba114) will increase coverage by 0.25%.
Report is 5 commits behind head on main.
The diff coverage is 28.57%.

@@            Coverage Diff             @@
##             main     #668      +/-   ##
==========================================
+ Coverage   49.87%   50.12%   +0.25%     
==========================================
  Files          63       64       +1     
  Lines         389      397       +8     
  Branches       75       77       +2     
==========================================
+ Hits          194      199       +5     
- Misses        185      187       +2     
- Partials       10       11       +1     
Flag Coverage Δ
hydrate ?
initialize ∅ <ø> (?)
migrate 100.00% <100.00%> (?)
setup ?
unit 49.61% <19.35%> (+0.26%) ⬆️

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

Files Changed Coverage Δ
src/initialize/index.ts 0.00% <0.00%> (ø)
src/initialize/initialize.ts 0.00% <0.00%> (ø)
src/initialize/initializeWithInformation.ts 0.00% <0.00%> (ø)
...rc/initialize/settings/addOwnerAsAllContributor.ts 0.00% <ø> (ø)
src/initialize/steps/clearChangelog.ts 0.00% <ø> (ø)
...tialize/steps/labels/getExistingEquivalentLabel.ts 100.00% <ø> (ø)
...initialize/steps/labels/migrateRepositoryLabels.ts 90.00% <ø> (ø)
src/initialize/steps/labels/outcomeLabels.ts 0.00% <ø> (ø)
...nitialize/steps/migrateBranchProtectionSettings.ts 100.00% <ø> (ø)
src/initialize/steps/migrateRepositorySettings.ts 0.00% <ø> (ø)
... and 41 more

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

@JoshuaKGoldberg JoshuaKGoldberg changed the title feat: reworked setup flow feat: reworked setup flow and renamed to "initialization" and "migration" Aug 21, 2023
@JoshuaKGoldberg JoshuaKGoldberg merged commit d22544f into main Aug 21, 2023
14 of 15 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the reworked-setup-flow branch August 21, 2023 23:46
@github-actions
Copy link

🎉 This is included in version v1.28.57 🎉

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: Rework the getting started flow & README.md docs
1 participant