Skip to content

Openapi add jenkins scripts fix linting#828

Merged
cryptoBeliever merged 6 commits intodevfrom
openapi_add_jenkins_scripts_fix_linting
Apr 21, 2026
Merged

Openapi add jenkins scripts fix linting#828
cryptoBeliever merged 6 commits intodevfrom
openapi_add_jenkins_scripts_fix_linting

Conversation

@cryptoBeliever
Copy link
Copy Markdown
Contributor

Summary

Add CI infrastructure for the OpenAPI module (analogous to symbol monorepo) and fix all yamllint
errors across the specification files.

CI & tooling

  • Add Jenkinsfile with defaultCiPipeline (environment: javascript)
  • Add scripts/ci/ (setup_lint, lint, build, test) and scripts/publish.sh
  • Add package.json scripts: lint:openapi, verify-links, postman, version:prepare, version:pack
  • Add @redocly/cli, markdown-link-check, openapi-to-postmanv2 as dev dependencies
  • Add .redocly.yaml and .markdown-link-check.json configuration
  • Add CONTRIBUTING.md and CODE_OF_CONDUCT.md
  • Register openapi module in .gitlintmodules

Yamllint fixes (1238 errors → 0)

  • Remove redundant quotes (quoted-strings: 677 errors)
  • Remove trailing whitespace (91 errors)
  • Add missing newline at end of file (54 errors)
  • Wrap long lines to stay within 140 character limit (62 errors)
  • Fix indentation issues (4 errors)
  • Fix empty brackets spacing and extra blank lines (2 errors)

@cryptoBeliever cryptoBeliever requested a review from Wayonb April 15, 2026 18:10
Copy link
Copy Markdown
Contributor

@Wayonb Wayonb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍🏾
a few comments consistency with double vs single quotes

Comment thread openapi/scripts/publish.sh Outdated
Comment thread openapi/scripts/publish.sh Outdated
Comment thread openapi/scripts/publish.sh Outdated
fi

echo "Creating GitHub release ${TAG}"
gh release create "${TAG}" \
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am assuming this publish script should also run in Jenkins? Or just local for now?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assumed local only for now. Do you think it makes sense to have it on Jenkins? If so, what adjustments should I make? 🤔

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, eventually needs to be part of Jenkins. I would need to make changes to Jenkins to support gh commands so we can do it in another PR.

Comment thread openapi/spec/openapi.yml Outdated
Comment thread openapi/spec/route_definitions/transaction/schemas/Transaction.yml Outdated
@cryptoBeliever cryptoBeliever requested a review from Wayonb April 20, 2026 19:12
Copy link
Copy Markdown
Contributor

@Wayonb Wayonb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple more things missing

  1. The OpenAPI Jenkins job is not created, update this file with the name and path - .github/buildConfiguration.yaml
  2. Make sure dependabot runs for OpenAPI, update - .github/dependabot.yaml

@cryptoBeliever
Copy link
Copy Markdown
Contributor Author

A couple more things missing

  1. The OpenAPI Jenkins job is not created, update this file with the name and path - .github/buildConfiguration.yaml
  2. Make sure dependabot runs for OpenAPI, update - .github/dependabot.yaml

@Wayonb

  1. I was sure I had already added this 😅 Added.
  2. Added.

Copy link
Copy Markdown
Contributor

@Wayonb Wayonb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏾

@cryptoBeliever cryptoBeliever merged commit a777f03 into dev Apr 21, 2026
22 checks passed
@cryptoBeliever cryptoBeliever deleted the openapi_add_jenkins_scripts_fix_linting branch April 21, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants