Skip to content

Latest commit

 

History

History
235 lines (156 loc) · 5.27 KB

CONTRIBUTING.md

File metadata and controls

235 lines (156 loc) · 5.27 KB
Raw

Contributing

Contributing encompasses repository specific requirements.

Requirements

You can check the requirements of ODH in the README section.

Writing code

Running locally

Development for both "frontend" and "backend" can be done while running:

npm run dev

But the recommended flow for development would be have two sessions, one for the frontend:

cd frontend
npm run start:dev

And one for the backend

cd backend
npm run start:dev

Give your dev env access

To give your dev environment access to the ODH configuration, log in to the OpenShift cluster and set the project to the location of the ODH installation

oc login https://api.my-openshift-cluster.com:6443 -u <username> -p <password>

or log in using the makefile and .env.local settings

OC_URL=https://specify.in.env:6443
OC_PROJECT=my-project
OC_USER=kubeadmin
OC_PASSWORD=my-password

make login

or

npm run make:login

Debugging and Testing

Unit testing

Tests using Jest to test util functions (not components).

npm run test:unit

Accessibility testing

Storybook tests using axe a11y testing plugin. This command requires a already running storybook instance. Start storybook with:

cd ./frontend && npm run storybook

Then run the accessibility tests with:

npm run test:accessibility

Integration testing

Playwright tests using storybook stories to test components. This command will start a storybook instance and run the tests or it will run the tests against an already running storybook instance.

npm run test:integration

End to end testing

Playwright tests using a running instance of the dashboard to test the full application. This command uses the environment variable E2E_DASHBOARD_URL=http://localhost:4010 in /frontend/.env.test to determine the url to test against.

npm run test:e2e

Linter testing

cd ./frontend && npm run test:lint

You can apply lint auto-fixes with

npm run test:fix

CI tests

The CI will run the command npm run test which will run the following tests:

npm run test:lint
npm run test:type-check
npm run tests:unit
npm run test:accessibility
npm run test:integration

Build

dotenv files

The current build leverages dotenv, or .env*, files to apply environment build configuration.

Applied dotenv files

dotenv files applied to the root of this project...

  • .env, basic settings, utilized by both "frontend" and "backend"
  • .env.local, gitignored settings, utilized by both "frontend" and "backend"
  • .env.development, utilized by both "frontend" and "backend". Its use can be seen with the NPM script $ npm run dev
  • .env.development.local, utilized by both "frontend" and "backend". Its use can be seen with the NPM script $ npm run dev
  • .env.production, is primarily used by the "frontend", minimally used by the "backend". Its use can be seen with the NPM script $ npm run start
  • .env.production.local, is primarily used by the "frontend", minimally used by the "backend". Its use can be seen with the NPM script $ npm run start
  • .env.test, is primarily used by the "frontend", minimally used by the "backend" during testing
  • .env.test.local, is primarily used by the "frontend", minimally used by the "backend" during testing

There are build processes in place that leverage the .env*.local files, these files are actively applied in our .gitignore in order to avoid build conflicts. They should continue to remain ignored, and not be added to the repository.

Available parameters

The dotenv files have access to default settings grouped by facet; frontend, backend, build

...

Deploy your version

Edit the opendatahub KfDef in your project, remove the section:

    - kustomizeConfig:
        repoRef:
          name: manifests
          path: odh-dashboard
      name: odh-dashboard

Remove the current deployment of the ODH Dashboard

make undeploy

or

npm run make:undeploy

Customize your env

Customize .env.local file to image and source information as desired. npm and the s2i command line tool is required.

IMAGE_REPOSITORY=quay.io/my-org/odh-dashboard:latest
OC_URL=https://specify.in.env:6443
OC_PROJECT=specify_in_.env

# user and password login
OC_USER=specify_in_.env
OC_PASSWORD=specify_in_.env

# or token login
#OC_TOKEN=specify_in_.env

Build command

Push your branch to your repo for it to be visible to the s2i build.

Then build:

make build

or

npm run make:build

Pushing the image

make push

or

npm run make:push

Deploying your image

Required: The OpenShift, oc, command line tool is required.

make deploy

or

npm run make:deploy

Pull Request Images

All pull requests will have an associated pr-<PULL REQUEST NUMBER> image built and pushed to quay.io for use in testing and verifying code changes as part of the PR code review. Any updates to the PR code will automatically trigger a new PR image build, replacing the previous hash that was referenced by pr-<PULL REQUEST NUMBER>.