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.

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

Update literature around changelog #242

Merged
merged 4 commits into from
Oct 19, 2022

Conversation

harshavamsi
Copy link
Contributor

Signed-off-by: Harsha Vamsi Kalluri [email protected]

Description

Introduces changelog and changelog verifier

Issues Resolved

[List any issues this PR will resolve]

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has comments added
    • New functionality is added to docs folder
  • 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.

@harshavamsi harshavamsi requested review from a team and madhusudhankonda as code owners October 14, 2022 17:09
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
@harshavamsi harshavamsi changed the title Add changelog and changelog verifier Update literature around changelog Oct 14, 2022
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Some more nits pls.

CONTRIBUTING.md Outdated


### How to add my changes to [CHANGELOG](CHANGELOG.md)?
### Adding changes
Copy link
Member

Choose a reason for hiding this comment

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

Should be "Adding Changes" to be consistent (capital C)

CONTRIBUTING.md Outdated
@@ -84,17 +84,17 @@ You may type this line on your own when writing your commit messages. However, i

## Changelog

OpenSearch-Java maintains version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep A Changelog](https://keepachangelog.com/en/1.0.0/) format.
OpenSearch-Java maintains a version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
Copy link
Member

Choose a reason for hiding this comment

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

The project is Opensearch-java (capital O because start of sentence).

Version-specific I think has a -.

@harshavamsi
Copy link
Contributor Author

@dblock updated with asks. I removed the PR template after our discussion here

VachaShah
VachaShah previously approved these changes Oct 18, 2022
@VachaShah VachaShah requested a review from dblock October 18, 2022 18:36
@dblock dblock requested a review from VachaShah October 19, 2022 13:18
@VachaShah VachaShah merged commit 832fe42 into opensearch-project:main Oct 19, 2022
abhinav-nath pushed a commit to abhinav-nath/opensearch-java that referenced this pull request Oct 21, 2022
* Update literature

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

* Removing pr template and updating language

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
abhinav-nath pushed a commit to abhinav-nath/opensearch-java that referenced this pull request Oct 21, 2022
* Update literature

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

* Removing pr template and updating language

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
Signed-off-by: Abhinav Nath <[email protected]>
VachaShah pushed a commit that referenced this pull request Oct 21, 2022
…#234)

* Add support to parse sub-aggregations from filter/nested aggregations

Signed-off-by: Abhinav Nath <[email protected]>

* Add USER_GUIDE.md

Signed-off-by: Abhinav Nath <[email protected]>

* Add DCO

Signed-off-by: Abhinav Nath <[email protected]>

* Add link to USER_GUIDE.md in README.md

Signed-off-by: Abhinav Nath <[email protected]>

* Add changelog and changelog verifier (#239)

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Signed-off-by: Abhinav Nath <[email protected]>

* Set javadoc encoding to utf-8 (#50) (#241)

Signed-off-by: Meetesh Kumawat<[email protected]>
Signed-off-by: meetesh <[email protected]>

Signed-off-by: Meetesh Kumawat<[email protected]>
Signed-off-by: meetesh <[email protected]>
Signed-off-by: Abhinav Nath <[email protected]>

* Update Jackson Databind to 2.13.4.2 (addressing CVE-2022-42003) (#240)

Signed-off-by: Andriy Redko <[email protected]>

Signed-off-by: Andriy Redko <[email protected]>
Signed-off-by: Abhinav Nath <[email protected]>

* Updates changelog for dependabot PRs (#247)

* Updates changelog for dependabot PRs

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

* Adding dependabot label for workflow

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Signed-off-by: Abhinav Nath <[email protected]>

* Update tests to use JUnit's Assert (#244)

Signed-off-by: Andriy Redko <[email protected]>

Signed-off-by: Andriy Redko <[email protected]>
Signed-off-by: Abhinav Nath <[email protected]>

* Update literature around changelog (#242)

* Update literature

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

* Removing pr template and updating language

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
Signed-off-by: Abhinav Nath <[email protected]>

* Bump grgit-gradle from 4.0.1 to 5.0.0 (#243)

* Bump grgit-gradle from 4.0.1 to 5.0.0

Bumps [grgit-gradle](https://github.com/ajoberstar/grgit) from 4.0.1 to 5.0.0.
- [Release notes](https://github.com/ajoberstar/grgit/releases)
- [Commits](ajoberstar/grgit@4.0.1...5.0.0)

---
updated-dependencies:
- dependency-name: org.ajoberstar.grgit:grgit-gradle
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* Update changelog

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>
Signed-off-by: Abhinav Nath <[email protected]>

* Add DCO

Signed-off-by: Abhinav Nath <[email protected]>

* Update CHANGELOG and README

Signed-off-by: Abhinav Nath <[email protected]>

* Add DCO

Signed-off-by: Abhinav Nath <[email protected]>

* Add DCO

Signed-off-by: Abhinav Nath <[email protected]>

* Fix CHANGLOG and README TOC

Signed-off-by: Abhinav Nath <[email protected]>

Signed-off-by: Abhinav Nath <[email protected]>
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Signed-off-by: Meetesh Kumawat<[email protected]>
Signed-off-by: meetesh <[email protected]>
Signed-off-by: Andriy Redko <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Harsha Vamsi Kalluri <[email protected]>
Co-authored-by: Meetesh Kumawat <[email protected]>
Co-authored-by: Andriy Redko <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>
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