Skip to content

Latest commit

 

History

History
92 lines (60 loc) · 4.09 KB

DEVELOPER_GUIDE.md

File metadata and controls

92 lines (60 loc) · 4.09 KB
Raw

Developer guide

So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.

Forking and Cloning

Fork this repository on GitHub, and clone locally with git clone.

Install Prerequisites

You will need to install node.js, nvm, and yarn in your environment to properly pull down dependencies to build and bootstrap the plugin.

Environment Setup

  1. Download OpenSearch for the version that matches the OpenSearch Dashboards version specified in package.json.

  2. Download and install OpenSearch Flow Framework.

  3. Download the OpenSearch Dashboards source code for the version specified in package.json you want to set up.

    See the OpenSearch Dashboards contributing guide and developer guide for more instructions on setting up your development environment.

  4. Change your node version to the version specified in .node-version inside the OpenSearch Dashboards root directory (this can be done with the nvm use command).

  5. Create a plugins directory inside the OpenSearch Dashboards source code directory, if plugins directory doesn't exist.

  6. Check out this package from version control into the plugins directory.

  7. Run yarn osd bootstrap inside OpenSearch-Dashboards/plugins/dashboards-flow-framework.

Ultimately, your directory structure should look like this:

.
├── OpenSearch-Dashboards
│   └──plugins
│      └── dashboards-flow-framework

Build

To build the plugin's distributable zip simply run yarn build.

Example output: ./build/dashboards-flow-framework-3.0.0.0.zip

Run

In the base OpenSearch Dashboards directory, run

yarn start --no-base-path

Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on localhost:5601.

Test

Unit Tests

yarn test:jest

Runs the plugin unit tests.

Integration Tests

Integration tests for this plugin are written using the Cypress test framework. The tests are maintained in the central opensearch-dashboards-functional-test repository. Steps to run the tests:

TODO

Formatting

This codebase uses Prettier as our code formatter. All new code that is added has to be reformatted using the Prettier version listed in package.json. In order to keep consistent formatting across the project developers should only use the prettier CLI to reformat their code using the following command:

yarn prettier --write <relative file path>

NOTE: There also exists prettier plugins on several editors that allow for automatic reformatting on saving the file. However using this is discouraged as you must ensure that the plugin uses the correct version of prettier (listed in package.json) before using such a plugin.

Backports

The Github workflow in backport.yml creates backport PRs automatically when the original PR with an appropriate label backport <backport-branch-name> is merged to main with the backport workflow run successfully on the PR. For example, if a PR on main needs to be backported to 1.x branch, add a label backport 1.x to the PR and make sure the backport workflow runs on the PR along with other checks. Once this PR is merged to main, the workflow will create a backport PR to the 1.x branch.