Merge pull request #2955 from shockey/ft/swagger-ui-dist
Publish swagger-ui-dist npm module
This commit is contained in:
30
.travis.yml
30
.travis.yml
@@ -7,21 +7,28 @@ branches:
|
|||||||
only:
|
only:
|
||||||
- master
|
- master
|
||||||
- /^v\d+\.\d+(\.\d+)?(-\S*)?$/
|
- /^v\d+\.\d+(\.\d+)?(-\S*)?$/
|
||||||
before_deploy: "npm run build-core"
|
before_deploy:
|
||||||
|
- npm run build
|
||||||
env:
|
env:
|
||||||
- DOCKER_IMAGE_NAME=swaggerapi/swagger-ui
|
- DOCKER_IMAGE_NAME=swaggerapi/swagger-ui
|
||||||
deploy:
|
deploy:
|
||||||
provider: npm
|
- provider: npm
|
||||||
email: apiteam@swagger.io
|
email: apiteam@swagger.io
|
||||||
skip_cleanup: true
|
skip_cleanup: true
|
||||||
api_key:
|
api_key:
|
||||||
secure: "IJkLaACa+rfERf1O5nwlqOyuo9sbul3FBhBt4Un9P+DvEet3AoDPV9NQVLd8SkmQYKGbGQWF4BIdjrO5nqFD6Te+JTeUX5Uo/DFS/fu9qw1xv0dQpvbJFuoYnnFlbzGTEs4CFa8lbu3ZromFHQGOQxRobjsG1Kf0dWFSSzmND3g="
|
secure: "IJkLaACa+rfERf1O5nwlqOyuo9sbul3FBhBt4Un9P+DvEet3AoDPV9NQVLd8SkmQYKGbGQWF4BIdjrO5nqFD6Te+JTeUX5Uo/DFS/fu9qw1xv0dQpvbJFuoYnnFlbzGTEs4CFa8lbu3ZromFHQGOQxRobjsG1Kf0dWFSSzmND3g="
|
||||||
on:
|
on:
|
||||||
tags: true
|
tags: true
|
||||||
repo: swagger-api/swagger-ui
|
repo: swagger-api/swagger-ui
|
||||||
node: '6.9'
|
node: '6.9'
|
||||||
|
- provider: script
|
||||||
|
script: swagger-ui-dist-package/deploy.sh
|
||||||
|
on:
|
||||||
|
tags: true
|
||||||
|
repo: swagger-api/swagger-ui
|
||||||
|
node: '6.9'
|
||||||
after_success:
|
after_success:
|
||||||
- if [ $DOCKER_HUB_USERNAME ]; then
|
- if [ $DOCKER_HUB_USERNAME ]; then
|
||||||
docker login --email=$DOCKER_HUB_EMAIL --username=$DOCKER_HUB_USERNAME --password=$DOCKER_HUB_PASSWORD;
|
docker login --email=$DOCKER_HUB_EMAIL --username=$DOCKER_HUB_USERNAME --password=$DOCKER_HUB_PASSWORD;
|
||||||
|
|
||||||
if [ ! -z "$TRAVIS_TAG" ]; then
|
if [ ! -z "$TRAVIS_TAG" ]; then
|
||||||
@@ -40,4 +47,3 @@ after_success:
|
|||||||
docker push $DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG;
|
docker push $DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG;
|
||||||
fi;
|
fi;
|
||||||
fi;
|
fi;
|
||||||
|
|
||||||
|
|||||||
@@ -58,7 +58,7 @@ To help with the migration, here are the currently known issues with 3.X. This l
|
|||||||
- Relative path support for external files is not implemented.
|
- Relative path support for external files is not implemented.
|
||||||
|
|
||||||
### SwaggerUIBundle
|
### SwaggerUIBundle
|
||||||
To use swagger-ui you should take a look at the [source of swagger-ui html page](https://github.com/swagger-api/swagger-ui/blob/master/dist/index.html) and customize it. This basically requires you to instantiate a SwaggerUi object and call load() on it as below:
|
To use swagger-ui's bundles, you should take a look at the [source of swagger-ui html page](https://github.com/swagger-api/swagger-ui/blob/master/dist/index.html) and customize it. This basically requires you to instantiate a SwaggerUi object as below:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
const ui = SwaggerUIBundle({
|
const ui = SwaggerUIBundle({
|
||||||
@@ -75,6 +75,8 @@ To use swagger-ui you should take a look at the [source of swagger-ui html page]
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you'd like to use the bundle files via npm, check out the [`swagger-ui-dist` package](npmjs.com/package/swagger-ui-dist).
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
Parameter Name | Description
|
Parameter Name | Description
|
||||||
|
|||||||
93
dist/swagger-ui-bundle.js
vendored
93
dist/swagger-ui-bundle.js
vendored
File diff suppressed because one or more lines are too long
2
dist/swagger-ui-bundle.js.map
vendored
2
dist/swagger-ui-bundle.js.map
vendored
@@ -1 +1 @@
|
|||||||
{"version":3,"file":"swagger-ui-bundle.js","sources":["webpack:///swagger-ui-bundle.js"],"mappings":"AAAA;AAu/FA;AA6+FA;;;;;;;;;;;;;;;;;;;;;;;;;;AA0dA;AAkoJA;AAyiCA;;;;;AAskCA;AA+4IA;AAs1FA;AAk3GA;AAuoEA;AAk+CA;AA6/CA;AA2rCA;AA24EA;AA66HA;;;;;;;;;;;;;;AA8vGA;AAyoIA;AAiuJA;AA8kHA;AAonGA;AAukEA;AA02DA;AA+2EA;AAm6GA;;;;;;AA4yEA;AA24FA;;;;;AAy3CA;AA2qFA;AAw2CA;AAglCA;AA0/CA;AAywEA;AA09FA;;;;;;;;;AA00BA;AA2zIA;AAk4DA;AAolDA;;;;;;AA6kCA;AA8iHA;AAipGA","sourceRoot":""}
|
{"version":3,"file":"swagger-ui-bundle.js","sources":["webpack:///swagger-ui-bundle.js"],"mappings":"AAAA;AAu/FA;AA6+FA;;;;;;;;;;;;;;;;;;;;;;;;;;AA4dA;;;;;;AAoIA;AAk7FA;AAmtCA;;;;;AA0uIA;AA+4IA;AAm9FA;AA2rGA;AA8lFA;AA2nFA;AAu9CA;AAyhDA;AAqrCA;AAy4EA;AA8/GA;;;;;;;;;;;;;;AA+mJA;AA4mIA;AAquJA;AAwsHA;AAinGA;AAkiEA;AAu4DA;AAs2DA;AAgpBA;;;;;;AAshFA;AAk0FA;;;;;AA23CA;AA2qFA;AAw2CA;AAglCA;AA0/CA;AAykFA;AA+1FA;;;;;;;;;AAk4CA;AA2zIA;AAk4DA;AAolDA","sourceRoot":""}
|
||||||
6
dist/swagger-ui-standalone-preset.js
vendored
6
dist/swagger-ui-standalone-preset.js
vendored
File diff suppressed because one or more lines are too long
2
dist/swagger-ui-standalone-preset.js.map
vendored
2
dist/swagger-ui-standalone-preset.js.map
vendored
@@ -1 +1 @@
|
|||||||
{"version":3,"file":"swagger-ui-standalone-preset.js","sources":["webpack:///swagger-ui-standalone-preset.js"],"mappings":"AAAA;;;;;AA6PA;AAyiGA","sourceRoot":""}
|
{"version":3,"file":"swagger-ui-standalone-preset.js","sources":["webpack:///swagger-ui-standalone-preset.js"],"mappings":"AAAA;;;;;AA4QA;AAitGA","sourceRoot":""}
|
||||||
2
dist/swagger-ui.css
vendored
2
dist/swagger-ui.css
vendored
File diff suppressed because one or more lines are too long
2
dist/swagger-ui.js
vendored
2
dist/swagger-ui.js
vendored
File diff suppressed because one or more lines are too long
2
dist/swagger-ui.js.map
vendored
2
dist/swagger-ui.js.map
vendored
@@ -1 +1 @@
|
|||||||
{"version":3,"file":"swagger-ui.js","sources":["webpack:///swagger-ui.js"],"mappings":"AAAA;;;;;;AA4wCA;AAoyHA;AAuxHA;AAy4FA;AA8rCA;AAugCA;AA+hCA;AA24BA","sourceRoot":""}
|
{"version":3,"file":"swagger-ui.js","sources":["webpack:///swagger-ui.js"],"mappings":"AAAA;;;;;;AA8wCA;AAoyHA;AAuxHA;AAy4FA;AA8rCA;AAugCA;AA+hCA;AA24BA","sourceRoot":""}
|
||||||
@@ -59,7 +59,7 @@ module.exports = function(options) {
|
|||||||
new webpack.DefinePlugin({
|
new webpack.DefinePlugin({
|
||||||
'process.env': {
|
'process.env': {
|
||||||
NODE_ENV: specialOptions.minimize ? JSON.stringify('production') : null,
|
NODE_ENV: specialOptions.minimize ? JSON.stringify('production') : null,
|
||||||
WEBPACK_INLINE_STYLES: !Boolean(specialOptions.separateStylesheets)
|
WEBPACK_INLINE_STYLES: !Boolean(specialOptions.separateStylesheets)
|
||||||
},
|
},
|
||||||
}))
|
}))
|
||||||
|
|
||||||
|
|||||||
2
swagger-ui-dist-package/.npmignore
Normal file
2
swagger-ui-dist-package/.npmignore
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
README.md
|
||||||
|
deploy.sh
|
||||||
1
swagger-ui-dist-package/.npmrc
Normal file
1
swagger-ui-dist-package/.npmrc
Normal file
@@ -0,0 +1 @@
|
|||||||
|
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
|
||||||
3
swagger-ui-dist-package/README.md
Normal file
3
swagger-ui-dist-package/README.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
This directory is used to build the `swagger-ui-dist` npm package.
|
||||||
|
|
||||||
|
For anything else, check the [Swagger-UI](https://github.com/swagger-api/swagger-ui) repository.
|
||||||
21
swagger-ui-dist-package/deploy.sh
Executable file
21
swagger-ui-dist-package/deploy.sh
Executable file
@@ -0,0 +1,21 @@
|
|||||||
|
# Deploy `swagger-ui-dist` to npm.
|
||||||
|
|
||||||
|
# Parameter Expansion: http://stackoverflow.com/questions/6393551/what-is-the-meaning-of-0-in-a-bash-script
|
||||||
|
cd "${0%/*}"
|
||||||
|
|
||||||
|
# Get UI version
|
||||||
|
UI_VERSION=$(node -p "require('../package.json').version")
|
||||||
|
|
||||||
|
# Replace our version placeholder with UI's version
|
||||||
|
sed -i '' "s|\$\$VERSION|$UI_VERSION|g" package.json
|
||||||
|
|
||||||
|
# Copy UI's dist files to our directory
|
||||||
|
cp ../dist/* .
|
||||||
|
|
||||||
|
if [[ $PUBLISH_DIST = "true" || $TRAVIS = "true" ]]; then
|
||||||
|
npm publish .
|
||||||
|
else
|
||||||
|
npm pack .
|
||||||
|
fi
|
||||||
|
|
||||||
|
find . -not -name .npmignore -not -name .npmrc -not -name deploy.sh -not -name package.json -not -name README.md -not -name *.tgz -delete
|
||||||
18
swagger-ui-dist-package/package.json
Normal file
18
swagger-ui-dist-package/package.json
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"name": "swagger-ui-dist",
|
||||||
|
"version": "$$VERSION",
|
||||||
|
"main": "dist/swagger-ui.js",
|
||||||
|
"repository": "git@github.com:swagger-api/swagger-ui.git",
|
||||||
|
"contributors": [
|
||||||
|
"(in alphabetical order)",
|
||||||
|
"Anna Bodnia <anna.bodnia@gmail.com>",
|
||||||
|
"Buu Nguyen <buunguyen@gmail.com>",
|
||||||
|
"Josh Ponelat <jponelat@gmail.com>",
|
||||||
|
"Kyle Shockey <kyleshockey1@gmail.com>",
|
||||||
|
"Robert Barnwell <robert@robertismy.name>",
|
||||||
|
"Sahar Jafari <shr.jafari@gmail.com>"
|
||||||
|
],
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"dependencies": {},
|
||||||
|
"devDependencies": {}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user