So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.
-
Download OpenSearch for the version that matches the OpenSearch Dashboards version specified in package.json.
-
Download the OpenSearch Dashboards source code for the version specified in package.json you want to set up.
-
Change your node version to the version specified in
.node-version
inside the OpenSearch Dashboards root directory. -
cd into the OpenSearch Dashboards source code directory.
-
Check out this package from version control into the
plugins
directory.
cd plugins
git clone git@github.com:opensearch-project/dashboards-visualizations.git
- Run
yarn osd bootstrap
insideOpenSearch-Dashboards
directory.
Ultimately, your directory structure should look like this:
.
├── OpenSearch Dashboards
│ └── plugins
│ └── dashboards-visualizations
To build the plugin's distributable zip simply run yarn build
.
Example output: ./build/gantt-chart-dashboards*.zip
-
yarn start
Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on
localhost:5601
. -
npx cypress run
Runs the plugin cypress tests.
See CONTRIBUTING.
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.