feat(static-doc): static documentation generation #60
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
educhastenier
force-pushed
the
feat/static_doc_gen
branch
from
0fe583d
to
a8fcb97
Compare
package.json
Outdated
| "clean": "rm -rf dist/*", | ||
| "yaml": "copyfiles -u 2 docs/images/* dist/static/images/ && redocly bundle -o dist/openapi.yaml -f", | ||
| "build": "npm run clean && npm run yaml", |
There was a problem hiding this comment.
@uguy you remove the build goal, but it IS CALLED by the GH Action!
educhastenier
force-pushed
the
feat/static_doc_gen
branch
from
fcea8fb
to
1cceac1
Compare
educhastenier
force-pushed
the
feat/static_doc_gen
branch
from
1cceac1
to
26f506a
Compare
| "yaml": "copyfiles -u 2 docs/images/* dist/bonita-openapi-$npm_package_version/images/ && redocly bundle -o dist/openapi.yaml -f", | ||
| "postman": "node_modules/.bin/openapi2postmanv2 -s dist/openapi.yaml -o dist/postman.json -p", | ||
| "static": "redoc-cli build ./dist/openapi.yaml -t docs/index.html.hbs --cdn -o ./dist/bonita-openapi-$npm_package_version/index.html && copyfiles -u 1 dist/openapi.yaml dist/bonita-openapi-$npm_package_version && copyfiles -u 1 dist/postman.json dist/bonita-openapi-$npm_package_version", | ||
| "package": "npm run clean && npm run test && npm run yaml && npm run postman && npm run static && cd dist/bonita-openapi-$npm_package_version && zip -r ../bonita-openapi-$npm_package_version.zip *" |
There was a problem hiding this comment.
@uguy you modify the deliverable assets, but not in the release.yml
Please do.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Generate static documentation that could be more search engine friendly.
Closes DEV-45