Skip to content

Latest commit

 

History

History
93 lines (57 loc) · 3.66 KB

DEVELOPER_GUIDE.md

File metadata and controls

93 lines (57 loc) · 3.66 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 Dashboard version specified in package.json.

  2. Download and install the appropriate OpenSearch Alerting plugin.

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

    See the OpenSearch Dashboards 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.

  5. cd into the plugins directory of the OpenSearch-Dashboards source code directory.

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

  7. Run yarn osd bootstrap inside Opensearch-Dashboards/plugins/alerting-dashboards-plugin.

Ultimately, your directory structure should look like this:

.
├── OpenSearch-Dashboards
│   └── plugins
│       └── alerting-dashboards-plugin

Build

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

Example output: ./build/alertingDashboards-1.0.0-rc1.zip

Run

  • yarn start

    • Starts OpenSearch-Dashboards and includes this plugin. OpenSearch-Dashboards will be available on localhost:5601.
    • Please run in the OpenSearch-Dashboards root directory
    • You must have OpenSearch running with the Alerting plugin

Test

There are unit/stubbed integration tests and Cypress e2e/integration tests.

  • yarn test:jest

    • Runs the plugin unit tests.

  • yarn run cypress open

    • Opens the Cypress test runner.

  • yarn run cypress run

    • Runs all Cypress tests headlessly in the Electron browser.

To run the Cypress tests, you must have both OpenSearch and OpenSearch-Dashboards running with the Alerting plugin.

If you are running Cypress tests with OpenSearch-Dashboards development server, pass these 2 options to yarn start:

  1. --no-base-path: opt out the BasePathProxy.
  2. --no-watch: make sure your server has not restarted.

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.

Backport