developer-setup.md

Developer Setup

Prerequisites

• Node.js version used by ci-operator-buildroot image
• Yarn package manager

GitHub repo setup

Fork the upstream OpenShift Dynamic Plugin SDK repo, then git clone your forked repo. Refer to GitHub docs for details.

We suggest renaming the Git remote representing the upstream repo to upstream. For example, assuming your GitHub user name is your_user_name:

$ git remote -v
upstream        https://github.com/openshift/dynamic-plugin-sdk.git (fetch)
upstream        https://github.com/openshift/dynamic-plugin-sdk.git (push)
your_user_name  https://github.com/your_user_name/dynamic-plugin-sdk.git (fetch)
your_user_name  https://github.com/your_user_name/dynamic-plugin-sdk.git (push)

Steps after cloning

yarn install
yarn build-libs

Alternatively, run test.sh which builds, lints and tests all the packages.

Lint and test specific file paths

yarn eslint path/to/lint
yarn jest path/to/test

Update API reports

After building libs, you may receive a warning regarding outdated API reports. To update them, run:

yarn api-extractor-local