Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 3.6 KB

DEVELOPER_GUIDE.md

File metadata and controls

86 lines (54 loc) · 3.6 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 the appropriate Index Management OpenSearch Plugin.

  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/index-management-dashboards-plugin.

Ultimately, your directory structure should look like this:

.
├── OpenSearch-Dashboards
│   └──plugins
│      └── index-management-dashboards-plugin

Build

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

Example output: ./build/index-management-dashboards-1.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

  • yarn start --no-base-path --no-watch --server.host="0.0.0.0"

    Starts OpenSearch Dashboards and includes this plugin. This setup is necessary for running tests using Cypress on localhost:5601.

    Important: The --server.host="0.0.0.0" parameter is crucial as it configures the server to accept connections from any IP address, which is necessary for Cypress to connect to the dashboard server.

  • yarn test:jest

    • Runs the plugin tests.

  • yarn run cypress open

    • Opens the Cypress test runner

  • yarn run cypress run

    • Runs the Cypress test runner

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.