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

Docs: Update chromatic-install.md #29547

Merged
merged 2 commits into from
Nov 19, 2024
Merged

Docs: Update chromatic-install.md #29547

merged 2 commits into from
Nov 19, 2024

Conversation

Borgund
Copy link
Contributor

@Borgund Borgund commented Nov 5, 2024

I noticed the 'Publish Storybook' docs was missing the install script for Chromatic when having set pnpm as the package manager.

What I did

Updated the documentation for 'Publish Storybook' to include an install script for chromatic when having pnpm selected as the package manager in code snipets.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

The change is adding a code snippet. So i assume it can be quickly verified manually. The MD is imported in the 'docs/sharing/publish-storybook.mdx' file and available on the docs page under: https://storybook.js.org/docs/sharing/publish-storybook#publish-storybook-with-chromatic

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Added pnpm installation command for Chromatic in the documentation snippets to provide complete package manager coverage alongside existing npm and yarn commands.

  • Added pnpm add --save-dev chromatic command in /docs/_snippets/chromatic-install.md
  • Installation snippet maintains consistent format with other package manager commands
  • Command appears in the "Publish Storybook with Chromatic" section of the documentation

I noticed the 'Publish Storybook' docs was missing the install script for Chromatic when having set pnpm as the package manager.
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@jonniebigodes jonniebigodes self-assigned this Nov 11, 2024
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Nov 11, 2024
@jonniebigodes jonniebigodes changed the title Update chromatic-install.md Docs: Update chromatic-install.md Nov 11, 2024
Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Thanks, @Borgund! 🙌

And congratulations on your first contribution!! 🥳

@kylegach kylegach added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Nov 19, 2024
Copy link

nx-cloud bot commented Nov 19, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 6318643. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@kylegach kylegach merged commit 487d2cb into storybookjs:next Nov 19, 2024
11 of 12 checks passed
yannbf pushed a commit that referenced this pull request Nov 20, 2024
Docs: Update chromatic-install.md
(cherry picked from commit 487d2cb)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants