{"_id":"@dandean/storybook-deployer","_rev":"3-c2e66035c1acf080186ae10710f0204d","name":"@dandean/storybook-deployer","dist-tags":{"latest":"2.8.4"},"versions":{"2.8.2":{"name":"@dandean/storybook-deployer","version":"2.8.2","description":"Deploy your storybook as a webapp.","keywords":["deploy","github","static","storybook"],"homepage":"https://github.com/storybooks/storybook-deployer#readme","bugs":{"url":"https://github.com/storybooks/storybook-deployer/issues"},"license":"MIT","author":{"name":"Arunoda Susiripala","email":"arunoda@kadira.io"},"bin":{"storybook-to-ghpages":"./bin/storybook_to_ghpages","storybook-to-aws-s3":"./bin/storybook_to_aws_s3"},"repository":{"type":"git","url":"git+https://github.com/dandean/storybook-deployer.git"},"dependencies":{"git-url-parse":"^8.1.0","glob":"^7.1.3","parse-repo":"^1.0.4","shelljs":"^0.8.1","yargs":"^11.0.0"},"devDependencies":{"husky":"^1.2.0","lint-staged":"^8.1.0","prettier":"^1.15.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"gitHead":"59e7627cfa2411e244fab840bd04f05c900e54a1","_id":"@dandean/storybook-deployer@2.8.2","_nodeVersion":"12.4.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-tjEy/VAoEBP3F40Zp7gg5J5pxFfOD9EC3avyvgwLetmRwF3OaXWZL1t3htKJnxOSMyyxbJkeXDUafdbC6CTr6Q==","shasum":"2d194b5b7e0d3242f295ec9e8b5de7613fa9ed1b","tarball":"https://registry.npmjs.org/@dandean/storybook-deployer/-/storybook-deployer-2.8.2.tgz","fileCount":12,"unpackedSize":27602,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeOvW5CRA9TVsSAnZWagAARz0P/j/+/Sd6S5W+WaOn+VeR\nuxWzbrKUn3B8GFzIDRZg1f6Zr6ZztE+4frETq3SdcRH7Xit23v5G67lea7/N\naesFP/X3gZKbz1FnwJAyot+NNPypNQOmTOPx+TvvPLJSapctoYM0+XnXzOmz\nFajyigHjh9/N7BIEZHOJtszVjdU1wLNlnD7mVmYwyUJdr5i4R74FkEutqJn3\nmgzp/vc4eRs8eSdqmhvB+fzxtZs6g4KZoShnfmJ36am+bak+aopERVe3+dO/\nt/GJ9euFSviJYoIfXhKDRSv3g+toVyOtJaoOZ2A4jsARMvT7PMfCc6LGQRu3\n8xQRVugTOJMznSRG9Jtn5V3Wbag15ycXWOJpnsAN1iAR/HJH8D9WjSDHFqQ4\nlJ3bvsu6L2JmrKg7Vksw/KRn6VvA6GByKP/+y0In1Py7dDHpuENDDWHnX1Dv\njBTSHU+6n9X5ef3grseJFSP8f89NNgAMImVEMCoY+4eaAPK/LoFxA264Hsz2\nqdZbTRuTvYcPLC66+ci6rQfBmpvJ48/f0pb9wU1VxsXLh9wOVc4Hdh8IoxUz\nn/VyLw4VPIXIhtSFiCqs8joSbDTkqGIWm3tDpQEy5QkoJF/Gt4qZqEyMzuKO\nlAYkDxOBzr8AzV7rIx8AO5E4cgOLj0y6s6N66t3WrwJCC5sPJXPBB/LeUVps\nhYlX\r\n=RCvA\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD76PECbL/CtMZxrDDfA6E6YIUL+s/h8CTlb5fUZDLhowIgRx7Y6O/ygdI1DXFBB/+cTmgAcxZHUaFncDxegoTYXew="}]},"maintainers":[{"name":"dandean","email":"me@dandean.com"}],"_npmUser":{"name":"dandean","email":"me@dandean.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-deployer_2.8.2_1580922296260_0.9042263503675989"},"_hasShrinkwrap":false},"2.8.3":{"name":"@dandean/storybook-deployer","version":"2.8.3","description":"Deploy your storybook as a webapp.","keywords":["deploy","github","static","storybook"],"homepage":"https://github.com/storybooks/storybook-deployer#readme","bugs":{"url":"https://github.com/storybooks/storybook-deployer/issues"},"license":"MIT","author":{"name":"Arunoda Susiripala","email":"arunoda@kadira.io"},"bin":{"storybook-to-ghpages":"./bin/storybook_to_ghpages","storybook-to-aws-s3":"./bin/storybook_to_aws_s3"},"repository":{"type":"git","url":"git+https://github.com/dandean/storybook-deployer.git"},"dependencies":{"git-url-parse":"^8.1.0","glob":"^7.1.3","parse-repo":"^1.0.4","shelljs":"^0.8.1","yargs":"^11.0.0"},"devDependencies":{"husky":"^1.2.0","lint-staged":"^8.1.0","prettier":"^1.15.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"gitHead":"59e7627cfa2411e244fab840bd04f05c900e54a1","_id":"@dandean/storybook-deployer@2.8.3","_nodeVersion":"12.4.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-xA+0hT/w7jRP4eMkB5zS1qnTaTjTmYf+LOysD1HHLG8HQ+VZrhBkwnOPa2v+YQtDA81tznuc4eKJidnB+AMqow==","shasum":"245e8a3c5a1365d935cb2a8b5a62cfae050b9e44","tarball":"https://registry.npmjs.org/@dandean/storybook-deployer/-/storybook-deployer-2.8.3.tgz","fileCount":12,"unpackedSize":27568,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeOviuCRA9TVsSAnZWagAA1EMP/RnoE+ujSXX8Venkf6fq\ny4xK/9xV1rwWUVxuGk6t2lD1ZkpazMLGspwTmsN0YiNjIIbuxVc6a0B9T+xa\nQOI2p9akqADCE85OmOntvcdT4QQY+Sz58yKK0CYW5Tvcf904zJ0D8ZE0ktkZ\n2AFw/SzF5KboqvxRNhHwJXGv4olfOG4M70I7wmkMIPW9wjQWyBPyq/Hh3wwf\nglYROho0REqj++lLSg2lUZudGbracs6XXyFAfctchU2r8gX6Rep07PzkmOXG\nfKJ+yrO7EIZnVzPm5XqlABIIE0eiQgwByQyNfYVFTSa/Viz86v3zDz5gHE4l\nyaxX8Ji7HsZeNUmLEUbtqv3gZr2QtRs+jadHQ0JQPhPqNYXznJxlGUccilTk\nd2127RMChgPlPf7etP4zdfVbgeg6ixWrEAPh7QmthtxG1ft2OcYSkHeC1YmR\nRzh/eCmxA7GgvWTjr85LdBSjjNwrZTDuKed9oVs5UCyzQSpAfikIoLdAwhf3\nYi5JUszAYK5ODmqSFGIwib5+QFlDmCJYP/OqeUpiJvyH2vLlbu5GJkvIrkQ5\nYpDCBLZIiZZbUQwwJ268aIRezl/tIY3LYrWLPOMbpKroatHhseNntV9lP+9s\n0mAkYuYLOsjw4Fk7iW3ctnT9Sq9/lrT/IGSROx/KZS4APpQpOese+XTuOt8P\nDweu\r\n=BM8M\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF5hoX7cEJvl+4KaWV3IGlVlu95DHMCU3lhsEuKROgLJAiEAgv+SS0g+M6XU/FQ3+3IHseaRdyBCcT7DKn/IzUddkLU="}]},"maintainers":[{"name":"dandean","email":"me@dandean.com"}],"_npmUser":{"name":"dandean","email":"me@dandean.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-deployer_2.8.3_1580923054187_0.44401672826226446"},"_hasShrinkwrap":false},"2.8.4":{"name":"@dandean/storybook-deployer","version":"2.8.4","description":"Deploy your storybook as a webapp.","keywords":["deploy","github","static","storybook"],"homepage":"https://github.com/storybooks/storybook-deployer#readme","bugs":{"url":"https://github.com/storybooks/storybook-deployer/issues"},"license":"MIT","author":{"name":"Arunoda Susiripala","email":"arunoda@kadira.io"},"bin":{"storybook-to-ghpages":"./bin/storybook_to_ghpages","storybook-to-aws-s3":"./bin/storybook_to_aws_s3"},"repository":{"type":"git","url":"git+https://github.com/dandean/storybook-deployer.git"},"dependencies":{"git-url-parse":"^8.1.0","glob":"^7.1.3","parse-repo":"^1.0.4","shelljs":"^0.8.1","yargs":"^11.0.0"},"devDependencies":{"husky":"^1.2.0","lint-staged":"^8.1.0","prettier":"^1.15.3"},"prettier":{"singleQuote":true},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,json,css,md}":["prettier --write","git add"]},"gitHead":"59e7627cfa2411e244fab840bd04f05c900e54a1","_id":"@dandean/storybook-deployer@2.8.4","_nodeVersion":"12.4.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-M+qRUzRAb/kFKmdZmXboH/geG5b/2AJ6PSluF3z5QHU7cL3JqY5/tGkgVmclhxL8Dn4gOBHr5UMVc0Hu42ysHg==","shasum":"3cffab09126cc405dcb5ecb9b12707d2cb457695","tarball":"https://registry.npmjs.org/@dandean/storybook-deployer/-/storybook-deployer-2.8.4.tgz","fileCount":12,"unpackedSize":28155,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeOv0qCRA9TVsSAnZWagAAFsAP/3ILGkeLuV09x18rOVgH\nnx5Qx6FuEE2Wt52wYdHicYbTMK3oGtft/3uYzIAQm8MZrQ1HFGZKScsROH9j\nqjhAbHr8WvBadaqOCgEN9Pf5e+kFZa/MsJTsMNb2HG90ClD/hwdpug+IcAWA\nOTTyG4P1T7ns+jaUgHgH42SqUY8FsYj9hKDw5PtxFDY34EZTxL+Oe2IXInii\n5vRFEkV0chmnb57MpSCoGT/FpZTTiqwfLghLBtKoeWJeeoldLxnhrc6GVOcr\ndLp8F9VYsufz/awTzr6Loy5DOrZFCEDvB+krC3ZykapifLaSeknhAaZa4ytw\n7fPJiPfHdFBX54q9WQ8BtqSBoQ+lZ+9cn8yXgqSGchMmDJaTvM3eneBbXYAd\nZGCdDsKiwjGOqB6pdzGKGRujJk6ozqAQLZitVzkiFjQczea+PK0+rXO+oFnP\nh4y5A54bUP2dR7EqDkQuYuwq/TCQkWwuUBfxDvDJqOS6g1xy0z6A0Zn1s9BN\nhQfdNqL/d6rndqolFwRHaqAcNsRCiPKN3zEnobz+Chr/rj6izUVZ9xQh/moI\nCz9RZ/eoy8y1jF/3uizxq30Bt1nXJuAqYGpy+zQ/6FQ6RBneok8d8l+4K8gA\n0V6uEViWNIpIKvqxdlvdwuP1pyOQ9L1xqWY+ils+9OifbjN2E7Sngofre/bC\nwFlH\r\n=5AlR\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCy16Nx5lj5HuJKFQdMQf31voSeq/BekpTJLm7LRu/LYgIhAMP3pc0kFeWYCMNcTbcS794cDfjgNwI0PcLp2F0mfeZw"}]},"maintainers":[{"name":"dandean","email":"me@dandean.com"}],"_npmUser":{"name":"dandean","email":"me@dandean.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-deployer_2.8.4_1580924201587_0.22001568925496873"},"_hasShrinkwrap":false}},"time":{"created":"2020-02-05T17:04:56.259Z","2.8.2":"2020-02-05T17:04:56.371Z","modified":"2022-04-05T02:39:34.178Z","2.8.3":"2020-02-05T17:17:34.288Z","2.8.4":"2020-02-05T17:36:41.743Z"},"maintainers":[{"name":"dandean","email":"me@dandean.com"}],"description":"Deploy your storybook as a webapp.","homepage":"https://github.com/storybooks/storybook-deployer#readme","keywords":["deploy","github","static","storybook"],"repository":{"type":"git","url":"git+https://github.com/dandean/storybook-deployer.git"},"author":{"name":"Arunoda Susiripala","email":"arunoda@kadira.io"},"bugs":{"url":"https://github.com/storybooks/storybook-deployer/issues"},"license":"MIT","readme":"# Storybook Deployer\n\nThis is a simple tool allows you to deploy your Storybook into a static hosting service. (Currently, GitHub Pages and AWS S3 beta)\n\n```sh\n$ storybook-to-ghpages --help\n$ storybook-to-aws-s3 --help\n\nOptions:\n  --help, -h                      Show help.                                             [boolean]\n  --version                       Show version number                                    [boolean]\n  --existing-output-dir, -e       If you have previously built your storybook output (through a\n                                  different CI step, etc) and just need to publish it     [string]\n  --out, -o                       Configure the output directory                          [string]\n  --packages, -p                  Directory for package.jsons (monorepo support)          [string]\n  --monorepo-index-generator, -m  Path to file to customize the monorepo index.html. This function\n                                  should return the html for the page.                    [string]\n  --script, -s                    Specify the build script in your package.json           [string]\n  --ci                            Deploy the storybook in CI mode (github only)          [boolean]\n  --dry-run                       Run build but hold off on publishing                   [boolean]\n  --remote                        Git remote to push to               [string] [default: \"origin\"]\n  --branch                        Git branch to push to             [string] [default: \"gh-pages\"]\n  --source-branch                 Source branch to push from          [string] [default: \"master\"]\n  --host-token-env-variable, -t   Github token for CI publish       [string] [default: \"GH_TOKEN\"]\n  --aws-profile                   AWS profile to use for publishing. Use NONE to use no profile\n                                  at all instead of \"default\".       [string] [default: \"default\"]\n  --bucket-path                   AWS bucket path to use for publishing                   [string]\n```\n\n## Getting Started\n\nInstall Storybook Deployer with:\n\n```\nnpm i @storybook/storybook-deployer --save-dev\n```\n\nThen add a NPM script like this for github page:\n\n```json\n{\n  \"scripts\": {\n    \"deploy-storybook\": \"storybook-to-ghpages\"\n  }\n}\n```\n\nor like this for AWS S3:\n\n```json\n{\n  \"scripts\": {\n    \"deploy-storybook\": \"storybook-to-aws-s3\"\n  }\n}\n```\n\nThen you can run `npm run deploy-storybook` to deploy the Storybook.\n\n### Custom Build Configuration\n\nIf you customize the build configuration with some additional params (like static file directory), then you need to expose another NPM script like this:\n\n```json\n{\n  \"scripts\": {\n    \"build-storybook\": \"build-storybook -s public\"\n  }\n}\n```\n\n### Configure Build Directory\n\nIf you need to configure the output directory you can supply the `out` flag.\n\n```sh\nnpm run deploy-storybook -- --out=.out\n```\n\n### Skip Build Step\n\nIf you have previously built your storybook output (through a different CI step, etc) and just need to publish it, specify the directory like this:\n\n```sh\nnpm run deploy-storybook -- --existing-output-dir=.out\n```\n\n### Skip Deploy Step\n\nif you want to see how everything build without pushing to a remote, use the `--dry-run` flag.\n\n```sh\nnpm run deploy-storybook -- --dry-run\n```\n\n### Deploy a Monorepo\n\nIf you manage a monorepo with multiple storybooks you can you pass the `packages` flag to `deploy-storybook` to scan a directory for `package.json`s.\n\nThe following command will search the `packages` directory for packages. It will also generate a default `index.html` that links to all of the loaded storybooks.\n\n```sh\nnpm run deploy-storybook -- --packages packages\n```\n\n### Customize Monorepo `index.html`\n\nTo customize the monorepo `index.html` you can pass the `monorepo-index-generator` flag to `deploy-storybook`. This file should export a function that receive the following arguments and returns the html for the page.\n\n- an array of all the `package.json` data from the loaded storybooks as the first argument\n- the output directory\n\n```sh\nnpm run deploy-storybook -- --monorepo-index-generator my-custom-generator.js\n```\n\n### Deploying Storybook as part of a CI service\n\nTo deploy Storybook as part of a CI step, pass the `ci` flag to `npm run deploy-storybook`.\n\nBecause pushing to GitHub as part of a CI step requires a [personal access token](https://github.com/blog/1509-personal-api-tokens), Storybook uses the `GH_TOKEN` environment variable, by default, to authenticate GitHub pushes.\n\nThis environment variable name can be configured via the `host-token-env-variable` flag.\n\nFor example, if your access token is stored in the `GH_TOKEN` environment variable\n\n```sh\nnpm run deploy-storybook -- --ci\n```\n\nOr if your access token is stored in the `GITHUB_TOKEN` environment variable\n\n```sh\nnpm run deploy-storybook -- --ci --host-token-env-variable=GITHUB_TOKEN\n```\n\n### Custom deploy configuration\n\nIf you want to customize Git username, email or commit message, add this to `package.json`:\n\n```json\n\"storybook-deployer\": {\n  \"gitUsername\": \"Custom Username\",\n  \"gitEmail\": \"custom@email.com\",\n  \"commitMessage\": \"Deploy Storybook [skip ci]\"\n}\n```\n\nIt will override the default configuration:\n\n```json\n\"storybook-deployer\": {\n  \"gitUsername\": \"GH Pages Bot\",\n  \"gitEmail\": \"hello@ghbot.com\",\n  \"commitMessage\": \"Deploy Storybook to GitHub Pages\"\n}\n```\n\nTo deploy Storybook to a remote other than `origin`, pass a `--remote` flag to `npm run deploy-storybook`.\nFor example, to deploy to your `upstream` remote:\n\n```sh\nnpm run deploy-storybook -- --remote=upstream\n```\n\nOr, to specify a target branch and serve your storybook with rawgit instead of gh-pages:\n\n```sh\nnpm run deploy-storybook -- --branch=feature-branch\n```\n\nOr, to specify a source branch other than `master`, pass a `--source-branch` flag to `npm run deploy-storybook`:\n\n```sh\nnpm run deploy-storybook -- --source-branch=release\n```\n\n#### Custom deploy configuration for S3\n\nFor AWS S3 deployment you must have [awscli](https://docs.aws.amazon.com/cli/latest/userguide/installing.html) installed.\n\nYou must specify a bucket path with `bucket-path` option: `my-bucket-name/path/to/destination-folder-in-bucket` and have the rights to write to this bucket.\n\nYou can change the aws profile used to run the command with the `aws-profile` option.\n\nexample: `storybook-to-aws-s3 --bucket-path=my-bucket-name/path/to/destination-folder-in-bucket --aws-profile=myprofile`\n\nYou can exclude the aws profile by setting this flag to \"NONE\":\n\nexample: `storybook-to-aws-s3 --bucket-path=my-bucket-name/path/to/destination-folder-in-bucket --aws-profile=NONE`\n","readmeFilename":"README.md"}