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

Add steps for how to run builds against local CLI #1113

Merged
merged 4 commits into from
Oct 30, 2024

Conversation

codykaup
Copy link
Contributor

@codykaup codykaup commented Oct 30, 2024

Just as the title says - this adds docs on how to run a separate project against your local copy of the CLI.

πŸ“¦ Published PR as canary version: 11.16.5--canary.1113.11667958515.0

✨ Test out this PR locally via:

npm install chromatic@11.16.5--canary.1113.11667958515.0
# or 
yarn add chromatic@11.16.5--canary.1113.11667958515.0

@codykaup codykaup added patch Auto: Increment the patch version when merged skip-release Auto: Preserve the current version when merged labels Oct 30, 2024
@codykaup codykaup self-assigned this Oct 30, 2024
Copy link
Contributor

github-actions bot commented Oct 30, 2024

πŸ“¦ Package Size: 5380 KB

Copy link

codacy-production bot commented Oct 30, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
Report missing for 478dbf61 βœ… βˆ… (target: 80.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (478dbf6) Report Missing Report Missing Report Missing
Head commit (8761bab) 7116 4839 68.00%

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 (#1113) 0 0 βˆ… (not applicable)

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

Footnotes

  1. Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct. ↩

@codykaup codykaup force-pushed the cody/cap-2353-update-cli-readme-on-how-to-run-locally branch from eaf998e to 1613b83 Compare October 30, 2024 18:29
@codykaup codykaup requested a review from a team October 30, 2024 18:33
@codykaup codykaup marked this pull request as ready for review October 30, 2024 18:33
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.

Do we want to mention the node <path/to/dist> option as well? Or call out the downsides of that method?

@codykaup
Copy link
Contributor Author

codykaup commented Oct 30, 2024

Do we want to mention the node <path/to/dist> option as well? Or call out the downsides of that method?

Good idea! I can call out the downsides here too The issues I originally ran into appear to be working? I'll just make a note as a warning to use the alternative if they see issues.

@codykaup codykaup force-pushed the cody/cap-2353-update-cli-readme-on-how-to-run-locally branch from 6ba38ad to 8761bab Compare October 30, 2024 19:31
@@ -60,7 +60,7 @@ async function build() {
await $({
stdout: 'inherit',
stderr: 'inherit',
})`sentry-cli releases set-commits --auto ${nextVersion}`;
})`sentry-cli releases set-commits --auto ${nextVersion} --ignore-missing`;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I rebased at some point which broke the sentry-cli because it couldn't find the commits. Passing --ignore-missing allows the CLI to fallback to the default behavior if it hits this error. Based on their docs, passing this every time shouldn't have a downside.

Copy link
Contributor

Choose a reason for hiding this comment

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

Send it!

@codykaup codykaup added this pull request to the merge queue Oct 30, 2024
Merged via the queue into main with commit db3848b Oct 30, 2024
20 checks passed
@codykaup codykaup deleted the cody/cap-2353-update-cli-readme-on-how-to-run-locally branch October 30, 2024 19:46
@chromatic-ci-bot
Copy link
Collaborator

πŸš€ PR was released in v11.16.4 πŸš€

@chromatic-ci-bot chromatic-ci-bot added the released Verdict: This issue/pull request has been released label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch Auto: Increment the patch version when merged released Verdict: This issue/pull request has been released skip-release Auto: Preserve the current version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants