GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-03-20 05:02:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

use -- --flag in docs & circleci

Browse Source
This commit is contained in:
Norbert de Langen 2017-07-24 07:52:56 +02:00
parent 86c25d626b
commit 6aad7a1cfc
2 changed files with 32 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.circleci/config.yml
View File

@ -40,7 +40,7 @@ jobs:
- run: - run:
name: "Bootstrapping" name: "Bootstrapping"
command: | command: |
npm run bootstrap npm run bootstrap -- --core
- save_cache: - save_cache:
key: package-dependencies-{{ checksum "package.json" }} key: package-dependencies-{{ checksum "package.json" }}
paths: paths:
@ -70,8 +70,7 @@ jobs:
- run: - run:
name: "Bootstrapping" name: "Bootstrapping"
command: | command: |
npm run bootstrap npm run bootstrap -- --core --test-cra
npm run bootstrap:test-cra
- run: - run:
name: "Running test-cra" name: "Running test-cra"
command: | command: |
@ -91,8 +90,7 @@ jobs:
- run: - run:
name: "Bootstrapping packages" name: "Bootstrapping packages"
command: | command: |
npm run bootstrap npm run bootstrap -- --core --react-native-vanilla
npm run bootstrap:react-native-vanilla
- run: - run:
name: "Running react-native" name: "Running react-native"
command: | command: |
@ -113,7 +111,7 @@ jobs:
- run: - run:
name: "Bootstrapping" name: "Bootstrapping"
command: | command: |
npm run bootstrap:docs npm run bootstrap -- --docs
- run: - run:
name: "Running docs" name: "Running docs"
command: | command: |
@ -149,10 +147,7 @@ jobs:
- run: - run:
name: "Bootstrapping" name: "Bootstrapping"
command: | command: |
npm run bootstrap npm run bootstrap -- --all
npm run bootstrap:docs
npm run bootstrap:test-cra
npm run bootstrap:react-native-vanilla
- run: - run:
name: "Unit testing" name: "Unit testing"
command: | command: |

50
CONTRIBUTING.md
View File

@ -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: 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 ```sh
cd storybook git clone https://github.com/storybooks/storybook.git
npm install cd storybook
npm run bootstrap npm install
npm run bootstrap
```
2. Link `storybook` and any other required dependencies 2. Link `storybook` and any other required dependencies:
cd app/react ```sh
npm link cd app/react
npm link
cd <your-project> cd <your-project>
npm link @storybook/react 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 ### 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: A good way to do that is using the example `test-cra` app embedded in this repository:
```bash ```sh
# Download and build this repository: # Download and build this repository:
git clone https://github.com/storybooks/storybook.git git clone https://github.com/storybooks/storybook.git
cd storybook 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 ### Closing issues
- Duplicate issues should be closed with a link to the original. - 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,
- 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). 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. - `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,
- `feature`s, `maintenance`s, `greenkeeper`s should be labelled `merged` when merged, and closed when released or if the feature is deemed not appropriate. and closed when released or if the feature is deemed not appropriate.
- `question / support`s should be closed when the question has been answered.
- `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. If the questioner drops offline, a reasonable period to wait is two weeks.
- `discussion`s should be closed at a maintainer's discretion. - `discussion`s should be closed at a maintainer's discretion.
## Development Guide ## 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. This project written in ES2016+ syntax so, we need to transpile it before use.
So run the following command: 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 ### Linking
@ -194,7 +198,7 @@ git status
git clean -fdx && yarn git clean -fdx && yarn
# build all the packages # 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. From here there are different procedures for prerelease (e.g. alpha/beta/rc) and proper release.