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

Jump to bottom

Create separate file for unreleased 3.0 changes #13040

Merged
merged 3 commits into from
Apr 9, 2024
Merged

Create separate file for unreleased 3.0 changes #13040

merged 3 commits into from
Apr 9, 2024

Conversation

andrross
Copy link
Member

@andrross andrross commented Apr 2, 2024 •
edited by kotwanikunal
Loading

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 GitHub Actions
Copy link
Contributor

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

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 GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 3, 2024

❌ 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?

@reta
Copy link
Collaborator

reta commented Apr 3, 2024

@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
Copy link
Member

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 GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 4, 2024

❌ 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 GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 4, 2024

❌ 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 GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 4, 2024

❌ 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
Copy link
Member Author

andrross commented Apr 4, 2024

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 GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 4, 2024

❌ 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
Copy link
Member Author

andrross commented Apr 4, 2024

❌ 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

@kotwanikunal kotwanikunal mentioned this pull request Apr 4, 2024
Closed
8 tasks
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 4, 2024

❌ 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
Copy link
Member Author

andrross commented Apr 5, 2024

❌ Gradle check result for 1c32252: FAILURE

#5329

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 5, 2024

❌ 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 and others added 3 commits April 5, 2024 16:09
@andrross
Create separate file for unreleased 3.0 changes
8d28aa0 
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 <[email protected]>
@kotwanikunal @andrross
Enhance changelog verifier script
c68c1da 
Signed-off-by: Kunal Kotwani <[email protected]>
@kotwanikunal @andrross
Update file names
5dcc3f1 
Signed-off-by: Kunal Kotwani <[email protected]>
@andrross andrross force-pushed the changelog-3.0-separate-file branch from 1c32252 to 5dcc3f1 Compare April 5, 2024 23:10
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 5, 2024

✅ Gradle check result for 5dcc3f1: SUCCESS

@codecov Codecov
Copy link

codecov bot commented Apr 5, 2024

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
dblock approved these changes Apr 8, 2024
View reviewed changes
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.

I like it.

@kotwanikunal kotwanikunal dismissed their stale review April 8, 2024 20:24

Changes added

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

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

@kotwanikunal
Copy link
Member

@peternied I can take care of it.

kotwanikunal added a commit to kotwanikunal/OpenSearch that referenced this pull request Apr 9, 2024
@andrross @kotwanikunal
Create separate file for unreleased 3.0 changes (opensearch-project#1…
b7a67dc 
…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 <[email protected]>
Signed-off-by: Kunal Kotwani <[email protected]>
Co-authored-by: Kunal Kotwani <[email protected]>
@kotwanikunal kotwanikunal mentioned this pull request Apr 9, 2024
Merged
8 tasks
andrross added a commit that referenced this pull request Apr 10, 2024
@kotwanikunal @andrross
[Backport 2.x] Create separate file for unreleased 3.0 changes (#13040)…
b7e1694 
… (#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 <[email protected]>
Signed-off-by: Kunal Kotwani <[email protected]>
Co-authored-by: Kunal Kotwani <[email protected]>

* Update changes as per 2.x

Signed-off-by: Kunal Kotwani <[email protected]>

---------

Signed-off-by: Andrew Ross <[email protected]>
Signed-off-by: Kunal Kotwani <[email protected]>
Co-authored-by: Andrew Ross <[email protected]>
@andrross andrross deleted the changelog-3.0-separate-file branch April 10, 2024 01:09
@cwperks cwperks mentioned this pull request Apr 16, 2024
Merged
8 tasks
shiv0408 pushed a commit to Gaurav614/OpenSearch that referenced this pull request Apr 25, 2024
@andrross @kotwanikunal @shiv0408
Create separate file for unreleased 3.0 changes (opensearch-project#1…
929b9f4 
…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 <[email protected]>
Signed-off-by: Kunal Kotwani <[email protected]>
Co-authored-by: Kunal Kotwani <[email protected]>
Signed-off-by: Shivansh Arora <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cwperks cwperks cwperks approved these changes

@dbwiddis dbwiddis dbwiddis approved these changes

@peternied peternied peternied approved these changes

@dblock dblock dblock approved these changes

@msfroh msfroh msfroh approved these changes

@kotwanikunal kotwanikunal kotwanikunal left review comments

@abbashus abbashus Awaiting requested review from abbashus

@adnapibar adnapibar Awaiting requested review from adnapibar

@anasalkouz anasalkouz Awaiting requested review from anasalkouz anasalkouz is a code owner

@Bukhtawar Bukhtawar Awaiting requested review from Bukhtawar Bukhtawar is a code owner

@CEHENKLE CEHENKLE Awaiting requested review from CEHENKLE CEHENKLE is a code owner

@dreamer-89 dreamer-89 Awaiting requested review from dreamer-89

@gbbafna gbbafna Awaiting requested review from gbbafna gbbafna is a code owner

@mch2 mch2 Awaiting requested review from mch2 mch2 is a code owner

@nknize nknize Awaiting requested review from nknize nknize is a code owner

@owaiskazi19 owaiskazi19 Awaiting requested review from owaiskazi19 owaiskazi19 is a code owner

@reta reta Awaiting requested review from reta reta is a code owner

@Rishikesh1159 Rishikesh1159 Awaiting requested review from Rishikesh1159 Rishikesh1159 is a code owner

@ryanbogan ryanbogan Awaiting requested review from ryanbogan

@sachinpkale sachinpkale Awaiting requested review from sachinpkale sachinpkale is a code owner

@saratvemulapalli saratvemulapalli Awaiting requested review from saratvemulapalli saratvemulapalli is a code owner

@shwetathareja shwetathareja Awaiting requested review from shwetathareja shwetathareja is a code owner

@sohami sohami Awaiting requested review from sohami sohami is a code owner

@tlfeng tlfeng Awaiting requested review from tlfeng

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

Assignees
No one assigned
Labels
bug Something isn't working Build Build Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[BUG] The Changelog Verifier GitHub Action runs 26 times and sends 26 emails if changelog is omitted
8 participants
@andrross @reta @peternied @msfroh @kotwanikunal @dblock @dbwiddis @cwperks