Create separate file for unreleased 3.0 changes #13040

andrross · 2024-04-02T23:22:24Z

Contributors and maintainers frequently put changelog entries in the wrong section. It's an easy mistake to make! Given that making changes intended for the next minor release is the norm, this change optimizes that process by making CHANGELOG.md contain only entries for the next minor. Truly breaking changes intended for the next major are kept in a separate file. Credit to @msfroh for the idea.

Note that the CHANGELOG-3.0.md content is not actually correct, because it contains mistakes intended to be fixed by this change going forward! That content can be cleaned up by a follow up PR.

Slack thread for additional context: https://opensearch.slack.com/archives/C05L60S4UBT/p1712011157190119

Resolves #13013

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
Commits are signed per the DCO using --signoff
Commit changes are listed out in CHANGELOG.md file (See: Changelog)
Public documentation issue/PR created

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.

github-actions · 2024-04-02T23:45:13Z

Compatibility status:

Checks if related components are compatible with change 5dcc3f1

Incompatible components

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/flow-framework.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/performance-analyzer.git]

github-actions · 2024-04-03T00:09:19Z

❌ Gradle check result for cbecb97: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

CHANGELOG-3.0.md

reta · 2024-04-03T13:38:55Z

@andrross totally understand the pain, could we (if it makes sense) follow this convention, each branch has own CHANGELOG, fe:

CHANGELOG-3.x
CHANGELOG-2.x
CHANGELOG-1.x

The main will keep:

CHANGELOG-3.x
CHANGELOG-2.x

The 2.x will keep:

CHANGELOG-2.x
CHANGELOG-1.x

I think it would be more straightforward to manage, what do you think? @peternied @dblock ?

peternied · 2024-04-03T13:48:35Z

could we (if it makes sense) follow this convention, each branch has own CHANGELOG, fe:

CHANGELOG-3.x
CHANGELOG-2.x
CHANGELOG-1.x

I second @reta suggestion, I would also say that it could be used as a way to automation and account for changed that have not been backported.

github-actions · 2024-04-04T18:40:02Z

❌ Gradle check result for 1017c20: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2024-04-04T18:50:22Z

❌ Gradle check result for 37570fb: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2024-04-04T18:54:40Z

❌ Gradle check result for f860fcd: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

andrross · 2024-04-04T19:05:00Z

I personally feel confused about treating main in a special way (CHANGELOG.md + CHANGELOG-3.0.md)

@reta I understand, but we are already treating main in a special way today as it is the only branch in which a CHANGELOG has multiple sections. This commit is actually kind of just cosmetic but it should mostly eliminate a class of common errors with regard to the changelog.

github-actions · 2024-04-04T19:23:37Z

❌ Gradle check result for 1c32252: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

andrross · 2024-04-04T19:55:05Z

❌ Gradle check result for 1c32252: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

#13046

github-actions · 2024-04-04T21:40:56Z

❌ Gradle check result for 1c32252: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

andrross · 2024-04-05T21:20:20Z

❌ Gradle check result for 1c32252: FAILURE

#5329

github-actions · 2024-04-05T21:51:27Z

❌ Gradle check result for 1c32252: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@msfroh

Contributors and maintainers frequently put changelog entries in the wrong section. It's an easy mistake to make! Given that making changes intended for the next minor release is the norm, this change optimizes that process by making `CHANGELOG.md` contain _only_ entries for the next minor. Truly breaking changes intended for the next major are kept in a separate file. Credit to @msfroh for the idea. Note that the CHANGELOG-3.0.md content is not actually correct, because it contains mistakes intended to be fixed by this change going forward! That content can be cleaned up by a follow up PR. Signed-off-by: Andrew Ross <andrross@amazon.com>

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

github-actions · 2024-04-05T23:57:23Z

✅ Gradle check result for 5dcc3f1: SUCCESS

codecov · 2024-04-05T23:58:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.52%. Comparing base (b15cb0c) to head (5dcc3f1).
Report is 137 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #13040      +/-   ##
============================================
+ Coverage     71.42%   71.52%   +0.10%     
- Complexity    59978    60522     +544     
============================================
  Files          4985     5026      +41     
  Lines        282275   284530    +2255     
  Branches      40946    41215     +269     
============================================
+ Hits         201603   203501    +1898     
- Misses        63999    64202     +203     
- Partials      16673    16827     +154

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dblock

I like it.

Changes added

peternied · 2024-04-09T19:36:48Z

@andrross Should this be backported, seems like the answer is yes, but it should be modified. Can you take this on?

kotwanikunal · 2024-04-09T19:47:05Z

@peternied I can take care of it.

@msfroh

…3040) Contributors and maintainers frequently put changelog entries in the wrong section. It's an easy mistake to make! Given that making changes intended for the next minor release is the norm, this change optimizes that process by making `CHANGELOG.md` contain _only_ entries for the next minor. Truly breaking changes intended for the next major are kept in a separate file. Credit to @msfroh for the idea. Signed-off-by: Andrew Ross <andrross@amazon.com> Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> Co-authored-by: Kunal Kotwani <kkotwani@amazon.com>

@msfroh

… (#13140) * Create separate file for unreleased 3.0 changes (#13040) Contributors and maintainers frequently put changelog entries in the wrong section. It's an easy mistake to make! Given that making changes intended for the next minor release is the norm, this change optimizes that process by making `CHANGELOG.md` contain _only_ entries for the next minor. Truly breaking changes intended for the next major are kept in a separate file. Credit to @msfroh for the idea. Signed-off-by: Andrew Ross <andrross@amazon.com> Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> Co-authored-by: Kunal Kotwani <kkotwani@amazon.com> * Update changes as per 2.x Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> --------- Signed-off-by: Andrew Ross <andrross@amazon.com> Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> Co-authored-by: Andrew Ross <andrross@amazon.com>

@msfroh

…3040) Contributors and maintainers frequently put changelog entries in the wrong section. It's an easy mistake to make! Given that making changes intended for the next minor release is the norm, this change optimizes that process by making `CHANGELOG.md` contain _only_ entries for the next minor. Truly breaking changes intended for the next major are kept in a separate file. Credit to @msfroh for the idea. Signed-off-by: Andrew Ross <andrross@amazon.com> Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> Co-authored-by: Kunal Kotwani <kkotwani@amazon.com> Signed-off-by: Shivansh Arora <hishiv@amazon.com>

msfroh approved these changes Apr 3, 2024

View reviewed changes

cwperks approved these changes Apr 3, 2024

View reviewed changes

cwperks reviewed Apr 3, 2024

View reviewed changes

CHANGELOG-3.0.md Show resolved Hide resolved

kotwanikunal force-pushed the changelog-3.0-separate-file branch from f860fcd to 1c32252 Compare April 4, 2024 18:26

kotwanikunal mentioned this pull request Apr 4, 2024

Skip gradle check for non code related changes #13085

Closed

8 tasks

peternied approved these changes Apr 4, 2024

View reviewed changes

dbwiddis approved these changes Apr 4, 2024

View reviewed changes

andrross and others added 3 commits April 5, 2024 16:09

Enhance changelog verifier script

c68c1da

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

Update file names

5dcc3f1

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

andrross force-pushed the changelog-3.0-separate-file branch from 1c32252 to 5dcc3f1 Compare April 5, 2024 23:10

dblock approved these changes Apr 8, 2024

View reviewed changes

peternied merged commit 3aaada6 into opensearch-project:main Apr 9, 2024
32 checks passed

kotwanikunal mentioned this pull request Apr 9, 2024

[Backport 2.x] Create separate file for unreleased 3.0 changes (#13040) #13140

Merged

8 tasks

andrross deleted the changelog-3.0-separate-file branch April 10, 2024 01:09

cwperks mentioned this pull request Apr 16, 2024

Cleanup CHANGELOG-3.0 #13216

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create separate file for unreleased 3.0 changes #13040

Create separate file for unreleased 3.0 changes #13040

andrross commented Apr 2, 2024 •

edited by kotwanikunal

Loading

github-actions bot commented Apr 2, 2024 •

edited

Loading

github-actions bot commented Apr 3, 2024

reta commented Apr 3, 2024

peternied commented Apr 3, 2024

github-actions bot commented Apr 4, 2024

github-actions bot commented Apr 4, 2024

github-actions bot commented Apr 4, 2024

andrross commented Apr 4, 2024

github-actions bot commented Apr 4, 2024

andrross commented Apr 4, 2024

github-actions bot commented Apr 4, 2024

andrross commented Apr 5, 2024

github-actions bot commented Apr 5, 2024

github-actions bot commented Apr 5, 2024

codecov bot commented Apr 5, 2024

dblock left a comment

peternied commented Apr 9, 2024

kotwanikunal commented Apr 9, 2024

Create separate file for unreleased 3.0 changes #13040

Create separate file for unreleased 3.0 changes #13040

Conversation

andrross commented Apr 2, 2024 • edited by kotwanikunal Loading

Check List

github-actions bot commented Apr 2, 2024 • edited Loading

Compatibility status:

Incompatible components

Skipped components

Compatible components

github-actions bot commented Apr 3, 2024

reta commented Apr 3, 2024

peternied commented Apr 3, 2024

github-actions bot commented Apr 4, 2024

github-actions bot commented Apr 4, 2024

github-actions bot commented Apr 4, 2024

andrross commented Apr 4, 2024

github-actions bot commented Apr 4, 2024

andrross commented Apr 4, 2024

github-actions bot commented Apr 4, 2024

andrross commented Apr 5, 2024

github-actions bot commented Apr 5, 2024

github-actions bot commented Apr 5, 2024

codecov bot commented Apr 5, 2024

Codecov Report

dblock left a comment

Choose a reason for hiding this comment

peternied commented Apr 9, 2024

kotwanikunal commented Apr 9, 2024

andrross commented Apr 2, 2024 •

edited by kotwanikunal

Loading

github-actions bot commented Apr 2, 2024 •

edited

Loading