Conversation
Wayonb
left a comment
There was a problem hiding this comment.
Looks good 👍🏾
a few comments consistency with double vs single quotes
| ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" | ||
| cd "${ROOT_DIR}" | ||
|
|
||
| VERSION="$(node -p "require('./package.json').version")" |
There was a problem hiding this comment.
instead of running node directly, shouldn't npm run version work? 🤔
There was a problem hiding this comment.
Right, thank you 👍 Replaced with npm run version --silent
| cd "${ROOT_DIR}" | ||
|
|
||
| VERSION="$(node -p "require('./package.json').version")" | ||
| TAG="${OPENAPI_RELEASE_TAG:-openapi-v${VERSION}}" |
There was a problem hiding this comment.
tag should be openapi/v${version}
|
|
||
| echo "Preparing OpenAPI release artifacts for ${TAG}" | ||
| npm run build | ||
| npm run postman |
There was a problem hiding this comment.
Is there a reason postman is not part of the build command? it seems to create a file that is part of the build. 🤔
There was a problem hiding this comment.
Hmm. Makes sense, added to build.
| fi | ||
|
|
||
| echo "Creating GitHub release ${TAG}" | ||
| gh release create "${TAG}" \ |
There was a problem hiding this comment.
I am assuming this publish script should also run in Jenkins? Or just local for now?
There was a problem hiding this comment.
I assumed local only for now. Do you think it makes sense to have it on Jenkins? If so, what adjustments should I make? 🤔
| openapi: 3.1.0 | ||
| info: | ||
| "$ref": "./info.yml" | ||
| "$ref": ./info.yml |
There was a problem hiding this comment.
Should be able to remove the " around the $ref?
| "8193": "./ProvisionNamespaceTransaction.yml" | ||
| "16385": "./MosaicDefinitionCreationTransaction.yml" | ||
| "16386": "./MosaicSupplyChangeTransaction.yml" | ||
| "257": ./TransferTransaction.yml |
There was a problem hiding this comment.
Not sure if quotes are needed here, but maybe a single quote instead of double
There was a problem hiding this comment.
Quotes are needed and should be replaced with single quotes (and, for consistency, in a few other places).
Summary
Add CI infrastructure for the OpenAPI module (analogous to symbol monorepo) and fix all yamllint
errors across the specification files.
CI & tooling
JenkinsfilewithdefaultCiPipeline(environment: javascript)scripts/ci/(setup_lint, lint, build, test) andscripts/publish.shpackage.jsonscripts:lint:openapi,verify-links,postman,version:prepare,version:pack@redocly/cli,markdown-link-check,openapi-to-postmanv2as dev dependencies.redocly.yamland.markdown-link-check.jsonconfigurationCONTRIBUTING.mdandCODE_OF_CONDUCT.mdopenapimodule in.gitlintmodulesYamllint fixes (1238 errors → 0)
quoted-strings: 677 errors)