Skip to content

[Feature/extensions] Catch up feature/extensions branch CHANGELOG#4479

Merged
owaiskazi19 merged 1 commit intoopensearch-project:feature/extensionsfrom
dbwiddis:changelog
Sep 14, 2022
Merged

[Feature/extensions] Catch up feature/extensions branch CHANGELOG#4479
owaiskazi19 merged 1 commit intoopensearch-project:feature/extensionsfrom
dbwiddis:changelog

Conversation

@dbwiddis
Copy link
Copy Markdown
Member

Description

Catches up the changelog forfeature/extensions branch with all merged (and non-reverted) PRs.

Issues Resolved

See discussion on #4477

Check List

  • [ ] New functionality includes testing.
    • [ ] All tests pass
  • [ ] New functionality has been documented.
    • [ ] New functionality has javadoc added
  • Commits are signed per the DCO using --signoff
  • Commit changes are listed out in CHANGELOG.md file (See: Changelog)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Daniel Widdis <widdis@gmail.com>
@dbwiddis dbwiddis requested review from a team and reta as code owners September 10, 2022 18:06
@github-actions
Copy link
Copy Markdown
Contributor

Gradle Check (Jenkins) Run Completed with:

@dbwiddis dbwiddis changed the title Catch up feature/extension branch CHANGELOG [Feature/extensions] Catch up feature/extensions branch CHANGELOG Sep 11, 2022
- Resolved javadoc error ([#3380](https://github.com/opensearch-project/OpenSearch/pull/3380))
- Read from extensions.yml ([#3381](https://github.com/opensearch-project/OpenSearch/pull/3381))
- Added unit tests and modified extension read logic for ExtensionsOrchestrator ([#3449](https://github.com/opensearch-project/OpenSearch/pull/3449))
- Removed Plugin Directory code from ExtensionsOrchestrator ([#3721](https://github.com/opensearch-project/OpenSearch/pull/3721))
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't this should be under Removed?

Copy link
Copy Markdown
Member Author

@dbwiddis dbwiddis Sep 12, 2022

Choose a reason for hiding this comment

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

Isn't this should be under Removed?

Good question. I'm not really sure. Some thoughts:

  • The Keep a Changelog link that inspires our change log notes that the log should be curated -- otherwise it's no different than a commit diff (from which I sourced this list). I anticipate that there will be a curation step between the current state and the eventual inclusion in the release notes.
  • In my view the purpose of a change log is to note changes. Work on a feature branch is primarily "new" work, thus my choice to include the entire list in "added". In my view "removed" would be something that was removed from a previous version of OpenSearch. So the only thing in this list that would fall under "removed" is actual OpenSearch functionality that is changed. In this particular case we're just updating one of the files we added in an earlier PR, so this particular line will probably be curated out (or the PR # combined with an earlier line grouping all actions on the ExtensionsOrchestrator together).

Would appreciate continued discussion in a more general case on #4477 where I will copy this comment.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This makes sense. There might be a case later where we will remove some functionality from OpenSearch as well. Do you think we can have Removed for such cases?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes, if we removed some functionality from OpenSearch it would most definitely be in "removed".

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What do we think about compressing multiple entries into one?

Consider

- Added thing to bar [PR1] [PR2]

Instead of

- Moved thing to bar [PR2]
- Added thing to foo [PR1]

@github-actions
Copy link
Copy Markdown
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Copy Markdown
Contributor

Gradle Check (Jenkins) Run Completed with:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants