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

CLI: Add line ignoring storybook's .log files upon init #26099

Merged
merged 5 commits into from
Feb 20, 2024

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Feb 19, 2024

Closes #26095

What I did

When user is using git, and user has a .gitignore file and this .gitignore file is within the project root, then add a line to that .gitignore file making git ignore files ending with *storybook.log, but only if that line isn't already found in the contents of the file.

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

  • create a monorepo with 2 projects
  • add a git ignore file to the root of your project
  • ensure the monorepo is using git
  • add storybook using the init command via the CLI to the first project
  • expect the .gitignore file to be updated
  • add storybook using the init command via the CLI to the second project
  • expect the .gitignore file to contain the added line only once

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/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>

@ndelangen ndelangen requested a review from shilman February 19, 2024 14:17
@ndelangen ndelangen self-assigned this Feb 19, 2024
@ndelangen ndelangen marked this pull request as ready for review February 19, 2024 14:18
@ndelangen ndelangen changed the title CLI: Add line ignoring storybook log files upon init CLI: Add line ignoring storybook .log files upon init Feb 19, 2024
@ndelangen ndelangen changed the title CLI: Add line ignoring storybook .log files upon init CLI: Add line ignoring storybook's .log files upon init Feb 19, 2024
@ndelangen ndelangen merged commit b5f8d9b into next Feb 20, 2024
58 checks passed
@ndelangen ndelangen deleted the norbert/add-line-to-gitignore-file branch February 20, 2024 08:57
@github-actions github-actions bot mentioned this pull request Feb 20, 2024
26 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Init: Add *storybook.log entry to .gitignore as part of sb init
2 participants