-
Notifications
You must be signed in to change notification settings - Fork 914
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
34 changed files
with
702 additions
and
313 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,76 @@ | ||
| ## Releasing | ||
|
|
||
| This project follows [OpenSearch project branching, labelling, and releasing](https://github.com/opensearch-project/.github/blob/main/RELEASING.md). | ||
| This project follows [OpenSearch project branching, labelling, and releasing](https://github.com/opensearch-project/.github/blob/main/RELEASING.md). | ||
|
|
||
| ## Runbook | ||
|
|
||
| ### Overview | ||
|
|
||
| The OpenSearch project releases versioned distributions of OpenSearch, OpenSearch Dashboards, and the OpenSearch plugins. This runbook details the steps involved in performing major, minor, and patch version releases for the OpenSearch Dashboards project; these steps need to be completed by the release managers (RM) assigned to each release. The RM is also responsible for updating the release status on the release tracking issues maintained on GitHub ([example](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/2230)). | ||
|
|
||
| \*Important Dates: https://opensearch.org/releases.html | ||
|
|
||
| ### Release Phase 1 - Preparation | ||
|
|
||
| For major and minor releases, the OpenSearch build repository [maintainers](https://github.com/opensearch-project/opensearch-build/blob/main/MAINTAINERS.md) will create a release issue in the OpenSearch Dashboards repository ([example](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/2230)) which links to the overall issue in the OpenSearch build repository ([example](https://github.com/opensearch-project/opensearch-build/issues/2447)). For patch releases, they will only create the overall issue in the OpenSearch build repository ([example](https://github.com/opensearch-project/opensearch-build/issues/2650)). | ||
|
|
||
| The OpenSearch Dashboards release issue will be assigned to the RM who should prepare for the release by reviewing all listed tasks. They should also compare the current release issue to the issue of the previous release version to ensure that all new processes have been captured. | ||
|
|
||
| The RM should review the [public roadmap](https://github.com/orgs/opensearch-project/projects/1) and confirm the release scope with other OpenSearch Dashboards [maintainers](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/MAINTAINERS.md) as well as the feature owners. Since release labels are intended to highlight the features and fixes meant for the upcoming release, the RM should verify that all issues and pull requests are labelled accordingly. For example, if current release version was v2.3.0, all features not ready for the release should be labeled as v2.4.0 or later by discussing with the feature owners. The RM should also check all PRs for the current release version to confirm that they are merged into the `main` branch and their backported PRs are merged with all CI passing. | ||
|
|
||
| #### How to validate that merged commits have been properly backported? | ||
|
|
||
| 1. For any PRs merged to main, make sure it has backport labels ([example - Add v2.3.0 release notes](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2318)) | ||
| 2. Backport PR is generated automatically by [opensearch-trigger-bot](https://github.com/apps/opensearch-trigger-bot) | ||
| ([example - [Backport 2.3] Add v2.3.0 release notes](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2333)) | ||
| 3. If the backport PR is not generated by opensearch-trigger-bot after 24 hours, create it manually following this [instruction](https://github.com/opensearch-project/.github/blob/main/RELEASING.md#backporting) | ||
| 4. Ensure that all CI passed and it has two approvals. Then merge the PR. | ||
|
|
||
| #### Prepare BWC data and update BWC versions | ||
|
|
||
| Backward Compatibility Tests (BWC) are cypress tests that identify any obvious compatibility bugs with previous versions. The RM should generate test data and test locally following instructions [here](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/TESTING.md#backwards-compatibility-tests) and cut PR to include both generated data and version upgrade for automated build. (See example [PR](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2393/files)) | ||
|
|
||
| #### Cut release branch for major / minor release | ||
|
|
||
| For major / minor release, the RM should cut the release branch from the parent branch, [following OpenSearch project branching](https://github.com/opensearch-project/.github/blob/main/RELEASING.md#opensearch-branching) | ||
|
|
||
| ### Release Phase 2 - Pre-Release | ||
|
|
||
| The release process for OpenSearch is centralized. Jenkins workflows are in place to regularly find differences in the OpenSearch and OpenSearch Dashboards components and create new snapshots for those that have been updated. The RM should update the release branch version in the distribution manifest (see example [PR](https://github.com/opensearch-project/opensearch-build/pull/2586/files)) and increment the parent branch version (see example [PR](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2295/files)). | ||
|
|
||
| #### Write release notes | ||
|
|
||
| OpenSearch Dashboards maintains a [CHANGELOG.md](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/CHANGELOG.md) and verifies it as part of the PR checklist step. For the time being, the RM should create release notes PR with the label `doc`, referring to the `CHANGELOG.md` (see example [PR](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2318)) | ||
|
|
||
| ### Release Phase 3 - Release testing | ||
|
|
||
| #### Verify integration and BWC test results | ||
|
|
||
| The automated integration test and BWC test are executed concurrently with the release artifacts build. The RM should examine the test results and assist in triaging the broken test case. | ||
|
|
||
| Example build: | ||
|
|
||
| x64: https://build.ci.opensearch.org/job/integ-test-opensearch-dashboards/995/ | ||
|
|
||
| arm64: https://build.ci.opensearch.org/job/integ-test-opensearch-dashboards/996/ | ||
|
|
||
| Example test results: | ||
| https://opensearch-project.github.io/opensearch-dashboards-functional-test/site/?version=2.3.0&build_number=4104&test_number=996 | ||
|
|
||
| Note: change `arch` to match the operating system CPU architecture for which the build is being produced. | ||
|
|
||
| #### Sanity test with tarball and docker image | ||
|
|
||
| Once the release candidate artifacts are built, the RM should configure the OpenSearch cluster with OpenSearch Dashboards according to the [instructions in the OpenSearch build repo](https://github.com/opensearch-project/opensearch-build/issues/2447#issuecomment-1241406594) and produce sanity tests to identify broken functionalities caused by new features / code changes. If you find any, please file bug reports and assist in triaging the bugfix. | ||
|
|
||
| ### Release Phase 4 - Release Announcement | ||
|
|
||
| Release artifacts and announcements will be available on https://opensearch.org/releases.html. Any website documentation changes will require a PR on the [OpenSearch documentation-website repo.](https://github.com/opensearch-project/documentation-website) | ||
|
|
||
| ### Release Phase 5 - Post-Release | ||
|
|
||
| After a release is announced, OpenSearch build repository maintainers will trigger a job that creates a tag in each repository based on the commit hash and branch that was included in the release; the release tag could take a few hours to show up on GitHub. | ||
|
|
||
| The RM should update the [release page](https://github.com/opensearch-project/OpenSearch-Dashboards/releases/) with the latest download URL and release notes after the release tag is created. | ||
|
|
||
| If needed, the RM could conduct a retrospective review of the release, and publish their findings regarding any missed steps and process improvements. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| # Usage | ||
|
|
||
| The purpose of this doc is to keep track of the current (as of 2022-11-14) usage of the [charts plugin](../../src/plugins/charts/), as well as other packages and tools with similar purposes. See https://github.com/opensearch-project/OpenSearch-Dashboards/issues/2830 for more information on future plans. | ||
|
|
||
| ## Lifecycle methods/services | ||
|
|
||
| ### `ChartsPluginStart` | ||
|
|
||
| 1. `ChartsPluginStart['theme']` used by `discover` plugin to fetch `chartsTheme` and `chartsBaseTheme` for use in styling the histogram. | ||
|
|
||
| ### `ChartsPluginSetup` | ||
|
|
||
| 1. `ChartsPluginSetup` declared as one of `MetricVisPluginSetupDependencies` in the `vis_type_metric` plugin, but isn't actually used. | ||
| 2. `ChartsPluginSetup['colors']` used by `vis_type_tagcloud` plugin. Only the seed colors are used via `d3.scale.ordinal().range(colors.seedColors)` | ||
| 3. `ChartsPluginSetup.colors` and `ChartsPluginSetup.theme` used by the `vis_type_timeseries` plugin. | ||
| 1. `themeService.useChartsBaseTheme()` is used only as a fallback; otherwise theme (dark or light) is calculated from the user-specified background color | ||
| 2. `colors.mappedColors` used to fetch mapped colors only if user has not specified a color for a particular series label (and there's no color specified from the server). | ||
| 4. `ChartsPluginSetup.colors.createColorLookupFunction()` is used by the `vis_type_vislib` plugin, ultimately, as part of `getColorFunc()` and `getPieColorFunc()`; the former also uses fallback for default and overwritten colors from `uiState`. | ||
| 5. Set as a dependency in stub plugin `vis_type_xy`, but not actually used. | ||
|
|
||
| ## `uiSettings` in advanced settings `visualization:colorMapping` | ||
|
|
||
| Appears to only be used by the telemetry plugin: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/95f4fd5c6a6cd59bd555bf0ec120843ef6a93566/src/plugins/telemetry/schema/oss_plugins.json#L1363 | ||
|
|
||
| ## Static functions and components | ||
|
|
||
| ### Color Maps | ||
|
|
||
| #### `ColorMap` interface | ||
|
|
||
| 1. `region_map` plugin | ||
| 2. `tile_map` plugin | ||
| 3. `timeline` plugin | ||
| 4. `vis_type_metric` plugin | ||
| 5. `vis_type_timeline` plugin | ||
|
|
||
| #### `ColorSchema` interface | ||
|
|
||
| 1. `maps_legacy` plugin | ||
| 2. `region_map` plugin | ||
| 3. `tile_map` plugin | ||
| 4. `vis_type_metric` plugin | ||
| 5. `vis_type_vislib` plugin | ||
| 6. `visualizations` plugin | ||
| 7. `visualize` plugin | ||
| 8. `vis_builder` plugin | ||
|
|
||
| #### `ColorSchemas` enum | ||
|
|
||
| 1. `region_map` plugin | ||
| 2. `tile_map` plugin | ||
| 3. `vis_type_metric` plugin | ||
| 4. `vis_type_vislib` plugin | ||
| 5. `vis_builder` plugin | ||
|
|
||
| #### `RawColorSchema` interface | ||
|
|
||
| Not used by any core plugins | ||
|
|
||
| #### `colorSchemas` array of objects | ||
|
|
||
| 1. `region_map` plugin | ||
| 2. `tile_map` plugin | ||
| 3. `vis_type_metric` plugin | ||
| 4. `vis_type_vislib` plugin | ||
| 5. `vis_builder` plugin | ||
|
|
||
| #### `getHeatmapColors` function | ||
|
|
||
| 1. `vis_type_metric` plugin | ||
| 2. `vis_type_vislib` plugin | ||
|
|
||
| #### `truncatedColorMaps` object | ||
|
|
||
| 1. `region_map` plugin | ||
| 2. `tile_map` plugin | ||
|
|
||
| #### `truncatedColorSchemas` array of objects | ||
|
|
||
| 1. `region_map` plugin | ||
| 2. `tile_map` plugin | ||
|
|
||
| #### `vislibColorMaps` object | ||
|
|
||
| 1. `vis_type_metric` plugin | ||
|
|
||
| ### React components | ||
|
|
||
| These components may eventually make more sense elsewhere. See https://github.com/opensearch-project/OpenSearch-Dashboards/issues/2832 for one such proposal. | ||
|
|
||
| #### `ColorModes` object | ||
|
|
||
| 1. `vis_type_metric` plugin | ||
| 2. `vis_type_vislib` plugin | ||
| 3. `vis_builder` plugin | ||
|
|
||
| #### `Rotates` object | ||
|
|
||
| 1. `vis_type_vislib` plugin | ||
|
|
||
| #### `BasicOptions` component | ||
|
|
||
| 1. `tile_map` plugin | ||
| 2. `vis_type_vislib` plugin | ||
| 3. `vis_builder` plugin | ||
|
|
||
| #### `ColorRanges` component | ||
|
|
||
| 1. `vis_type_metric` plugin | ||
| 2. `vis_type_vislib` plugin | ||
| 3. `vis_builder` plugin | ||
|
|
||
| #### `ColorSchemaOptions` component | ||
|
|
||
| Accounts for customized `vis.colors` in the `uiState`. Supports setting custom colors via legend, and resetting. | ||
|
|
||
| 1. `vis_type_metric` plugin. Doesn't actually support custom colors | ||
| 2. `vis_type_vislib` plugin | ||
| 3. `vis_builder` plugin (metric visualization). Doesn't support custom colors | ||
|
|
||
| #### `NumberInputOption` component | ||
|
|
||
| 1. `region_map` plugin | ||
| 2. `vis_type_table` plugin | ||
| 3. `vis_type_vislib` plugin | ||
|
|
||
| #### `RangeOption` component | ||
|
|
||
| 1. `tile_map` plugin | ||
| 2. `vis_type_markdown` plugin | ||
| 3. `vis_type_metric` plugin | ||
| 4. `vis_type_timeseries` plugin | ||
| 5. `vis_builder` plugin | ||
|
|
||
| #### `RequiredNumberInputOption` component | ||
|
|
||
| 1. `vis_type_vislib` plugin | ||
|
|
||
| #### `SelectOption` component | ||
|
|
||
| 1. `index_pattern_management` plugin | ||
| 2. `maps_legacy` plugin | ||
| 3. `region_map` plugin | ||
| 4. `tile_map` plugin | ||
| 5. `vis_type_table` plugin | ||
| 6. `vis_type_tagcloud` plugin | ||
| 7. `vis_type_timeseries` plugin | ||
| 8. `vis_type_vislib` plugin | ||
| 9. `vis_builder` plugin | ||
|
|
||
| #### `SwitchOption` component | ||
|
|
||
| 1. `maps_legacy` plugin | ||
| 2. `region_map` plugin | ||
| 3. `tile_map` plugin | ||
| 4. `vis_type_markdown` plugin | ||
| 5. `vis_type_metric` plugin | ||
| 6. `vis_type_table` plugin | ||
| 7. `vis_type_tagcloud` plugin | ||
| 8. `vis_type_vislib` plugin | ||
| 9. `vis_builder` plugin | ||
|
|
||
| #### `TextInputOption` component | ||
|
|
||
| 1. `maps_legacy` plugin | ||
| 2. `vis_type_vislib` plugin | ||
|
|
||
| # OUI chart colors | ||
|
|
||
| An alternative to using color schemas and maps provided by the `charts` plugin is to use [color palettes from OUI](https://github.com/opensearch-project/oui/blob/main/src/services/color/oui_palettes.ts). | ||
|
|
||
| ## `ouiPaletteColorBlind()` | ||
|
|
||
| 1. `index_pattern_management` plugin | ||
| 2. `vis_type_vega` plugin | ||
| 3. `vis_type_vislib` plugin | ||
|
|
||
| ## Other quantitative palettes | ||
|
|
||
| Not currently used | ||
|
|
||
| ## `colorPalette` | ||
|
|
||
| Not currently used |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.