Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Data source] Fix datasource filtering issue #5484

Merged
merged 3 commits into from
Nov 29, 2023
Merged

[Data source] Fix datasource filtering issue #5484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
807a369
fix datasource filtering issue
mengweieric Nov 16, 2023
78489e8
Merge branch 'main' into fix/datasource-filter
mengweieric Nov 27, 2023
4de6601
added filtering fix to changelog
mengweieric Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- [BUG] Add platform "darwin-arm64" to unit test ([#5290](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5290))
- [BUG][Dev Tool] Add dev tool documentation link to dev tool's help menu [#5166](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5166)
- Fix missing border for header navigation control on right ([#5450](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5450))
- [BUG] Fix filtering issue in data source selector ([5484](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5484))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm.

question for core team, why do we need to manually maintain changelog? can it be generated automatically with
https://github.com/tj/git-extras/blob/HEAD/Commands.md#git-changelog
or
https://github.com/orhun/git-cliff

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would make sense but not every commit message is clean enough for the changelog. So it would require clean commit messages.

We also have another POC in the process: #5519

In response to opensearch-project/.github#148

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but not every commit message is clean enough

i think that should anyways be improved, one option is to enforce conventional commits. Then it becomes easy to auto generate changelog or changeset, also git becomes more useful. thanks for the references, if i have time i might raise something

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joshuali925 There was a whole big analysis of this problem - the working group decided that developer commit messages were not sufficient for representing changes to a non-dev audience.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joshuarrrr I want to bring this conversation off from this PR. but I asked why not to automate it because after randomly clicking a few items in the change log, the wording for each item is pretty much the same as its PR title.

the working group decided that developer commit messages were not sufficient for representing changes to a non-dev audience

I agree putting commit messages together is not enough for a release note, but with changelog I still find it difficult to understand as a user. For example, looking at [Discover] Display inner properties in the left navigation bar under "Features/Enhancements" in the changelog, i have no idea what this does.

From https://keepachangelog.com/en/1.1.0/,

A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project.

A commit should represent a change, to me a list of notable commits sounds like the definition of a changelog. I think changelog or commit messages with release notes (summary and highlights) should be enough to represent changes to a non-dev audience (this is commonly done in other projects, i can give examples). My ask is mainly to avoid manually writing the changelog if possible


### 🚞 Infrastructure

Expand Down
1 change: 0 additions & 1 deletion src/plugins/data/public/data_sources/datasource_selector/datasource_selectable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,6 @@ export const DataSourceSelectable = ({
onChange={handleSourceChange}
singleSelection={singleSelection}
isClearable={false}
async
/>
);
};
Loading