OpenSearch-Dashboards
OpenSearch-Dashboards copied to clipboard
feat: add config for topRightNavigation
Description
Add opensearchDashboards.topRightNavigation
config and control dev tool top right nav button.
Screenshot
topRightNavigation disabled by default
topRightNavigation enabled
Testing the changes
- By default or add
opensearchDashboards.topRightNavigation: false
in yml file, top right navigation will not display. - add
opensearchDashboards.topRightNavigation: true
in yml file, top right navigation will display.
Changelog
- feat: Add
opensearchDashboards.topRightNavigation
config and control dev tool top right nav button.
Check List
- [ ] All tests pass
- [ ]
yarn test:jest
- [ ]
yarn test:jest_integration
- [ ]
- [ ] New functionality includes testing.
- [ ] New functionality has been documented.
- [ ] Update CHANGELOG.md
- [ ] Commits are signed per the DCO using --signoff
❌ Empty Changelog Section
The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 67.64%. Comparing base (
b830fe1
) to head (a7d2107
).
Additional details and impacted files
@@ Coverage Diff @@
## main #6712 +/- ##
==========================================
- Coverage 67.66% 67.64% -0.03%
==========================================
Files 3417 3417
Lines 66941 66941
Branches 10892 10892
==========================================
- Hits 45297 45283 -14
- Misses 18991 19004 +13
- Partials 2653 2654 +1
Flag | Coverage Δ | |
---|---|---|
Linux_1 | 33.16% <ø> (ø) |
|
Linux_2 | 55.59% <ø> (ø) |
|
Linux_3 | 45.22% <ø> (+<0.01%) |
:arrow_up: |
Linux_4 | 34.82% <ø> (ø) |
|
Windows_2 | ? |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
have we looked into ui settings? might be a little easier.
Thanks. That looks easier. But here feel like that we more need some configuration to be a role of feature flag. Like workspace feature flag.
❌ Entry Too Long
Entry is 122 characters long, which is 22 characters longer than the maximum allowed length of 100 characters. Please revise your entry to be within the maximum length.
Seems failing test is the same as main after merging it. https://github.com/opensearch-project/OpenSearch-Dashboards/actions/runs/8954435518/job/24594081770
Spoke to @raintygao offline:
- There wasnt a new API introduced, but rather a component
RightNavigationButton
(PR). This I think should be marked as experimental since I can see this being more general with simpler props and needs a bit of discussion - The
topRightNavigation
feature is being introduced as a part of a bigger change to improve the navigation. This however currently isnt something everyone aligns on. Since only the dev tools icon uses this, we can use the workspaces feature flag to gate this for 2.14 since its a release blocker and reconsider what the correct config flag needs to be long term for 2.15.
These two changes should unblock this PR.
The backport to 2.x
failed:
The process '/usr/bin/git' failed with exit code 128
To backport manually, run these commands in your terminal:
# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-6712-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c09285c24703f9015d811f76bcd026061b705398
# Push it to GitHub
git push --set-upstream origin backport/backport-6712-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x
Then, create a pull request where the base
branch is 2.x
and the compare
/head
branch is backport/backport-6712-to-2.x
.
The backport to 2.14
failed:
The process '/usr/bin/git' failed with exit code 1
To backport manually, run these commands in your terminal:
# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.14 2.14
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.14
# Create a new branch
git switch --create backport/backport-6712-to-2.14
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c09285c24703f9015d811f76bcd026061b705398
# Push it to GitHub
git push --set-upstream origin backport/backport-6712-to-2.14
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.14
Then, create a pull request where the base
branch is 2.14
and the compare
/head
branch is backport/backport-6712-to-2.14
.
manual backport made here: https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6727 https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6728