mirror of
https://github.com/storybookjs/storybook.git
synced 2025-03-20 05:02:37 +08:00
use -- --flag in docs & circleci
This commit is contained in:
Norbert de Langen
parent
86c25d626b
commit
6aad7a1cfc
@ -40,7 +40,7 @@ jobs:
|
||||
- run:
|
||||
name: "Bootstrapping"
|
||||
command: |
|
||||
npm run bootstrap
|
||||
npm run bootstrap -- --core
|
||||
- save_cache:
|
||||
key: package-dependencies-{{ checksum "package.json" }}
|
||||
paths:
|
||||
@ -70,8 +70,7 @@ jobs:
|
||||
- run:
|
||||
name: "Bootstrapping"
|
||||
command: |
|
||||
npm run bootstrap
|
||||
npm run bootstrap:test-cra
|
||||
npm run bootstrap -- --core --test-cra
|
||||
- run:
|
||||
name: "Running test-cra"
|
||||
command: |
|
||||
@ -91,8 +90,7 @@ jobs:
|
||||
- run:
|
||||
name: "Bootstrapping packages"
|
||||
command: |
|
||||
npm run bootstrap
|
||||
npm run bootstrap:react-native-vanilla
|
||||
npm run bootstrap -- --core --react-native-vanilla
|
||||
- run:
|
||||
name: "Running react-native"
|
||||
command: |
|
||||
@ -113,7 +111,7 @@ jobs:
|
||||
- run:
|
||||
name: "Bootstrapping"
|
||||
command: |
|
||||
npm run bootstrap:docs
|
||||
npm run bootstrap -- --docs
|
||||
- run:
|
||||
name: "Running docs"
|
||||
command: |
|
||||
@ -149,10 +147,7 @@ jobs:
|
||||
- run:
|
||||
name: "Bootstrapping"
|
||||
command: |
|
||||
npm run bootstrap
|
||||
npm run bootstrap:docs
|
||||
npm run bootstrap:test-cra
|
||||
npm run bootstrap:react-native-vanilla
|
||||
npm run bootstrap -- --all
|
||||
- run:
|
||||
name: "Unit testing"
|
||||
command: |
|
||||
|
||||
@ -20,22 +20,26 @@ No software is bug free. So, if you got an issue, follow these steps:
|
||||
|
||||
To test your project against the current latest version of storybook, you can clone the repository and link it with `npm`. Try following these steps:
|
||||
|
||||
1. Download the latest version of this project, and build it
|
||||
1. Download the latest version of this project, and build it:
|
||||
|
||||
git clone https://github.com/storybooks/storybook.git
|
||||
cd storybook
|
||||
npm install
|
||||
npm run bootstrap
|
||||
```sh
|
||||
git clone https://github.com/storybooks/storybook.git
|
||||
cd storybook
|
||||
npm install
|
||||
npm run bootstrap
|
||||
```
|
||||
|
||||
2. Link `storybook` and any other required dependencies
|
||||
2. Link `storybook` and any other required dependencies:
|
||||
|
||||
cd app/react
|
||||
npm link
|
||||
```sh
|
||||
cd app/react
|
||||
npm link
|
||||
|
||||
cd <your-project>
|
||||
npm link @storybook/react
|
||||
cd <your-project>
|
||||
npm link @storybook/react
|
||||
|
||||
# repeat with whichever other parts of the monorepo you are using.
|
||||
# repeat with whichever other parts of the monorepo you are using.
|
||||
```
|
||||
|
||||
### Reproductions
|
||||
|
||||
@ -43,7 +47,7 @@ The best way to help figure out an issue you are having is to produce a minimal
|
||||
|
||||
A good way to do that is using the example `test-cra` app embedded in this repository:
|
||||
|
||||
```bash
|
||||
```sh
|
||||
# Download and build this repository:
|
||||
git clone https://github.com/storybooks/storybook.git
|
||||
cd storybook
|
||||
@ -115,15 +119,13 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p
|
||||
### Closing issues
|
||||
|
||||
- Duplicate issues should be closed with a link to the original.
|
||||
|
||||
- Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline, it is reasonable to wait 2 weeks before closing).
|
||||
|
||||
- Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline,
|
||||
it is reasonable to wait 2 weeks before closing).
|
||||
- `bug`s should be labelled `merged` when merged, and be closed when the issue is fixed and released.
|
||||
|
||||
- `feature`s, `maintenance`s, `greenkeeper`s should be labelled `merged` when merged, and closed when released or if the feature is deemed not appropriate.
|
||||
|
||||
- `question / support`s should be closed when the question has been answered. If the questioner drops offline, a reasonable period to wait is two weeks.
|
||||
|
||||
- `feature`s, `maintenance`s, `greenkeeper`s should be labelled `merged` when merged,
|
||||
and closed when released or if the feature is deemed not appropriate.
|
||||
- `question / support`s should be closed when the question has been answered.
|
||||
If the questioner drops offline, a reasonable period to wait is two weeks.
|
||||
- `discussion`s should be closed at a maintainer's discretion.
|
||||
|
||||
## Development Guide
|
||||
@ -133,9 +135,11 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p
|
||||
This project written in ES2016+ syntax so, we need to transpile it before use.
|
||||
So run the following command:
|
||||
|
||||
npm run dev
|
||||
```sh
|
||||
npm run dev
|
||||
```
|
||||
|
||||
This will watch files and transpile.
|
||||
This will watch files and transpile in watch mode.
|
||||
|
||||
### Linking
|
||||
|
||||
@ -194,7 +198,7 @@ git status
|
||||
git clean -fdx && yarn
|
||||
|
||||
# build all the packages
|
||||
npm run bootstrap
|
||||
npm run bootstrap -- --all
|
||||
```
|
||||
|
||||
From here there are different procedures for prerelease (e.g. alpha/beta/rc) and proper release.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user