Add workflow for changelog verification by kotwanikunal · Pull Request #4085 · opensearch-project/OpenSearch

kotwanikunal · 2022-08-02T06:27:20Z

Signed-off-by: Kunal Kotwani kkotwani@amazon.com

Description

The changes under this PR build on adding a changelog enforcer using the GHA Changelog Enforcer following the Keep A Changelog format
What this solves for currently:
- Enforcing all new PRs made to the repo have a changelog attached to them
- Dependabot PRs have the appropriate changes automatically added to the CHANGELOG.md file
What this currently does not solve for:
- Backported PRs will have issues since the changes will not be automatically added to the older version within the changelog file

Issues Resolved

[PROPOSAL] Author CHANGELOG in each PR instead of collecting them in the last days before a release #1868

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

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: Kunal Kotwani <kkotwani@amazon.com>

github-actions · 2022-08-02T06:38:05Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/1245/
CommitID: a5a1090

kotwanikunal · 2022-08-02T16:32:14Z

> Task :libs:opensearch-grok:compileTestJava
Note: Some input files use or override a deprecated API.
Note: Recompile with -Xlint:deprecation for details.

Problems handling incoming cache access requests.
java.lang.OutOfMemoryError: Java heap space

github-actions · 2022-08-02T16:57:46Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/1278/
CommitID: a5a1090

.github/workflows/changelog_verifier.yml

kotwanikunal · 2022-08-16T16:24:54Z

@dblock What do you think of this?
Related: #1868

dblock · 2022-08-16T16:43:45Z

.github/workflows/changelog_verifier.yml

+name: "Changelog Verifier"
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]


Why not all PRs?

The default mechanism for pull_request trigger is as follows:

By default, a workflow only runs when a pull_request event's activity type is opened, synchronize, or reopened.

I have updated the GHA config to reflect all the types I found could match our case.

dblock · 2022-08-16T16:44:18Z

CHANGELOG.md

+
+## [ UNRELEASED ]
+### Added
+- Github workflow for changelog verification


Let's start with a format that includes a link to the PR?

The only concern I have with that is it will become a 2 step process -

Add changelog with dummy link and raise the PR

Update the changelog and commit again with the PR link

Let me check if there is an automated mechanism/property within the used GHA to achieve this.

Working backwards from the end goal of users being able to find what the change was I think that's an acceptable overhead.

dblock

I love it. Super simple. Let's update developer docs too?

kotwanikunal · 2022-08-16T18:51:58Z

I love it. Super simple. Let's update developer docs too?

Yes. I will update the PR as soon as we have the syntax and process finalized.

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>

github-actions · 2022-08-18T02:40:23Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/1869/
CommitID: fb9d28e61b9f58180a9720d6270e7389f79599ba

github-actions · 2022-08-18T02:56:28Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/1870/
CommitID: f8986a9

github-actions · 2022-08-18T04:33:16Z

Gradle Check (Jenkins) Run Completed with:

RESULT: ABORTED ❌
URL: https://build.ci.opensearch.org/job/gradle-check/1868/
CommitID: fc2879a5c72ad774235725f399a8a583a1030fa2

rursprung

i like the idea of being able to enforce this in an automated way so that it isn't forgotten!

CONTRIBUTING.md

.github/pull_request_template.md

dblock · 2022-08-18T15:28:05Z

CONTRIBUTING.md

+## [ UNRELEASED ]
+### Added
+- ...
+- Add support for FooBar client ([#9999](https://github.com/opensearch-project/OpenSearch/pull/9999))


Is it possible to change the format to include the contributor alias? I want to give people easy credit for the work they do.

as i already wrote in opensearch-project/security#1821 (comment) i personally don't think listing the contributors is a good idea. when reading the changelog i want to know what changed and what it means for me - any other information is just annoying clutter and will be ignored and slows me down. i can always follow the links or check the commit history to know more.

We could potentially use github aliases within the format, but like the PRs, it would be a self update process.
+1 on following the PR links / browsing commit history to reduce information overload.

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>

github-actions · 2022-08-18T17:41:40Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/1892/
CommitID: 6aa2ecd

kotwanikunal · 2022-08-18T19:51:57Z

Gradle check:


FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':distribution:bwc:minor:buildBwcLinuxTar'.
> Building 2.2.0 didn't generate expected file /var/jenkins/workspace/gradle-check/search/distribution/bwc/minor/build/bwc/checkout-2.x/distribution/archives/linux-tar/build/distributions/opensearch-min-2.2.0-SNAPSHOT-linux-x64.tar.gz

github-actions · 2022-08-18T20:24:13Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/1904/
CommitID: 6aa2ecd

github-actions · 2022-08-18T21:04:36Z

Gradle Check (Jenkins) Run Completed with:

RESULT: UNSTABLE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/1906/
CommitID: 2116581

kotwanikunal · 2022-08-18T22:21:14Z

Unrelated:

Tests with failures:
 - org.opensearch.index.fielddata.SortedSetDVStringFieldDataTests.testSortMissingLastReverse

github-actions · 2022-08-18T22:22:18Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/1908/
CommitID: 2116581

CHANGELOG.md

rursprung · 2022-08-19T06:05:41Z

CONTRIBUTING.md

+
+For example, as a contributor, my change adds support for a new `FooBar` client, the changes would look like -
+
+```


tbh, i don't really see the value in duplicating the content of a near-empty CHANGELOG.md here again. why not just write

Suggested change

```

2. Add an entry for your change to the corresponding section in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there.

or, if you truly want to keep it, at least turn it into markdown syntax highlighting:

Suggested change

```

```md

Updated the PR!

CONTRIBUTING.md

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>

…OpenSearch into changelog-verifier

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>

github-actions · 2022-08-22T17:37:25Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/1987/
CommitID: 208d4c9

github-actions · 2022-08-22T17:45:29Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/1988/
CommitID: 291f4d5

dblock · 2022-08-23T17:19:00Z

I merged it. Let's backport to 2.x and try to run with this.

* Add workflow for changelog verification Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update format for changelog, add developer documentation Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update link reference to be relative to project Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Fix links for CHANGELOG versions Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update contribution guide Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> (cherry picked from commit 5327767)

* Add workflow for changelog verification Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update format for changelog, add developer documentation Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update link reference to be relative to project Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Fix links for CHANGELOG versions Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update contribution guide Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> (cherry picked from commit 5327767) Co-authored-by: Kunal Kotwani <kkotwani@amazon.com>

dblock · 2022-08-25T13:44:15Z

@kotwanikunal Are you going to take this on as a campaign for all plugins once it's stable here? Maybe we need to open sub-issues in those repos?

kotwanikunal · 2022-08-29T17:04:26Z

@dblock I can run that once we ensure the process and any further automation/guardrails are in place.
I am also backporting all the changes to 1.x right now.

* Add workflow for changelog verification Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update format for changelog, add developer documentation Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update link reference to be relative to project Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Fix links for CHANGELOG versions Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update contribution guide Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> (cherry picked from commit 5327767)

* Add workflow for changelog verification Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update format for changelog, add developer documentation Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update link reference to be relative to project Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Fix links for CHANGELOG versions Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update contribution guide Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> (cherry picked from commit 5327767) Co-authored-by: Kunal Kotwani <kkotwani@amazon.com>

lukas-vlcek · 2022-08-31T17:05:42Z

@kotwanikunal @dblock I think the changelog doc link in the checklist section is broken.

I recently opened this PR #4360 and you can see that the link points to https://github.com/opensearch-project/OpenSearch/CONTRIBUTING.md#changelog which is wrong. Correct link is https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#changelog.

Maybe we need to change the relative link from [Changelog](../CONTRIBUTING.md#changelog) to [Changelog](../blob/main/CONTRIBUTING.md#changelog) ?

kotwanikunal · 2022-08-31T19:17:55Z

@kotwanikunal @dblock I think the changelog doc link in the checklist section is broken.

I recently opened this PR #4360 and you can see that the link points to https://github.com/opensearch-project/OpenSearch/CONTRIBUTING.md#changelog which is wrong. Correct link is https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#changelog.

Maybe we need to change the relative link from [Changelog](../CONTRIBUTING.md#changelog) to [Changelog](../blob/main/CONTRIBUTING.md#changelog) ?

I'll add in the fix. Thanks for bringing it to notice.

kotwanikunal · 2022-09-01T17:24:47Z

@lukas-vlcek Fixed it with #4364

Add workflow for changelog verification

a5a1090

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>

kotwanikunal mentioned this pull request Aug 2, 2022

Add label checks for PRs #3618

Closed

5 tasks

kotwanikunal marked this pull request as ready for review August 2, 2022 16:22

kotwanikunal requested review from a team and reta as code owners August 2, 2022 16:22

kotwanikunal mentioned this pull request Aug 2, 2022

[PROPOSAL] Author CHANGELOG in each PR instead of collecting them in the last days before a release #1868

Closed

dreamer-89 mentioned this pull request Aug 2, 2022

[Bug]: gradle check failing with java heap OutOfMemoryError #3973

Closed

tlfeng reviewed Aug 4, 2022

View reviewed changes

.github/workflows/changelog_verifier.yml Outdated Show resolved Hide resolved

tlfeng added CI CI related v3.0.0 Issues and PRs related to version 3.0.0 labels Aug 4, 2022

dblock reviewed Aug 16, 2022

View reviewed changes

kotwanikunal self-assigned this Aug 17, 2022

kotwanikunal force-pushed the changelog-verifier branch from fc2879a to fb9d28e Compare August 18, 2022 02:33

Update format for changelog, add developer documentation

f8986a9

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>

kotwanikunal force-pushed the changelog-verifier branch from fb9d28e to f8986a9 Compare August 18, 2022 02:34

rursprung reviewed Aug 18, 2022

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

dblock reviewed Aug 18, 2022

View reviewed changes

.github/pull_request_template.md Outdated Show resolved Hide resolved

dblock reviewed Aug 18, 2022

View reviewed changes

Update link reference to be relative to project

6aa2ecd

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>

Merge branch 'opensearch-project:main' into changelog-verifier

2116581

rursprung reviewed Aug 19, 2022

View reviewed changes

kotwanikunal added 3 commits August 22, 2022 10:12

Fix links for CHANGELOG versions

d4a92cd

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>

Merge branch 'changelog-verifier' of https://github.com/kotwanikunal/…

208d4c9

…OpenSearch into changelog-verifier

Update contribution guide

291f4d5

Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>

dblock merged commit 5327767 into opensearch-project:main Aug 23, 2022

dblock added the backport 2.x Backport to 2.x branch label Aug 23, 2022

opensearch-trigger-bot bot mentioned this pull request Aug 23, 2022

[Backport 2.x] Add workflow for changelog verification #4284

Merged

dblock mentioned this pull request Aug 25, 2022

[META] Introduce keep-a-changelog to all clients opensearch-project/opensearch-clients#33

Closed

kotwanikunal added the backport 1.x label Aug 29, 2022

opensearch-trigger-bot bot mentioned this pull request Aug 29, 2022

[Backport 1.x] Add workflow for changelog verification #4323

Merged

kotwanikunal deleted the changelog-verifier branch September 1, 2022 17:24

dreamer-89 added the v2.3.0 'Issues and PRs related to version v2.3.0' label Sep 8, 2022


		For example, as a contributor, my change adds support for a new `FooBar` client, the changes would look like -

		```

	```
	2. Add an entry for your change to the corresponding section in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there.

Conversation

kotwanikunal commented Aug 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Check List

Uh oh!

github-actions bot commented Aug 2, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

kotwanikunal commented Aug 2, 2022

Uh oh!

github-actions bot commented Aug 2, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

Uh oh!

kotwanikunal commented Aug 16, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dblock left a comment

Choose a reason for hiding this comment

Uh oh!

kotwanikunal commented Aug 16, 2022

Uh oh!

github-actions bot commented Aug 18, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Aug 18, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Aug 18, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

rursprung left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 18, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

kotwanikunal commented Aug 18, 2022

Uh oh!

github-actions bot commented Aug 18, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Aug 18, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

kotwanikunal commented Aug 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Aug 18, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Aug 22, 2022

Gradle Check (Jenkins) Run Completed with:

Uh oh!

kotwanikunal commented Aug 2, 2022 •

edited

Loading

kotwanikunal commented Aug 18, 2022 •

edited

Loading

dblock commented Aug 23, 2022 •

edited

Loading