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

Show steps for initializing a new Git repo #1081

Conversation

codykaup
Copy link
Contributor

@codykaup codykaup commented Oct 4, 2024

It can be a little confusing when you try to run Chromatic in a directory that isn't a Git repo. You end up going through a couple of error steps before you finally get to a workable state. This adds a suggestion how to initialize an empty Git repo and add a single commit. Therefore, you only go through 1 error before you can run a build.

📦 Published PR as canary version: 11.12.0--canary.1081.11220007939.0

✨ Test out this PR locally via:

npm install chromatic@11.12.0--canary.1081.11220007939.0
# or 
yarn add chromatic@11.12.0--canary.1081.11220007939.0

@codykaup codykaup added release Auto: Create a `latest` release when merged minor Auto: Increment the minor version when merged labels Oct 4, 2024
@codykaup codykaup self-assigned this Oct 4, 2024
Copy link
Contributor

github-actions bot commented Oct 4, 2024

📦 Package Size: 5268 KB
✅ Compared to main: 0 KB bd798a1 (5268 KB)

Copy link

codacy-production bot commented Oct 4, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
-0.01% (target: -1.00%) 25.00% (target: 80.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (bd798a1) 8606 4647 54.00%
Head commit (21cb727) 8609 (+3) 4648 (+1) 53.99% (-0.01%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#1081) 4 1 25.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

@codykaup codykaup marked this pull request as ready for review October 4, 2024 20:49
@codykaup codykaup requested a review from a team October 4, 2024 20:49
Copy link
Contributor

@jmhobbs jmhobbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Would it make sense to perhaps link to the git book? If you're unaware of how to create a git repo, more docs would probably be a good thing. https://git-scm.com/book/en/v2

@codykaup
Copy link
Contributor Author

codykaup commented Oct 7, 2024

Looks good. Would it make sense to perhaps link to the git book? If you're unaware of how to create a git repo, more docs would probably be a good thing. https://git-scm.com/book/en/v2

Excellent idea! I'll toss that in there too!

@codykaup codykaup added this pull request to the merge queue Oct 7, 2024
Merged via the queue into main with commit 1f55db6 Oct 7, 2024
19 of 20 checks passed
@codykaup codykaup deleted the cody/cap-2208-update-cli-to-show-more-helpful-error-for-unlinked-projects branch October 7, 2024 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor Auto: Increment the minor version when merged release Auto: Create a `latest` release when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants