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

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

Closed
dblock opened this issue Aug 25, 2022 · 7 comments
Closed

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

dblock opened this issue Aug 25, 2022 · 7 comments
Labels
enhancement New feature or request

Comments

@dblock
Copy link
Member

dblock commented Aug 25, 2022

What kind of business use case are you trying to solve? What are your requirements?

Release notes are of varying quality. Similar to opensearch-project/OpenSearch#1868.

What is the problem? What is preventing you from meeting the requirements?

  • Release notes aren't always super useful and may lack context.
  • Release notes are only available at release time, and not during development, so it's unclear what has changed.

What are you proposing? What do you suggest we do to solve the problem or improve the existing situation?

  1. Replace authoring release notes at the end before a release with authoring release notes in each PR.
  2. Require that release notes be updated via something like danger-changelog with every change.

An implementation of this was done in OpenSearch core in opensearch-project/OpenSearch#4085. Copy-paste that into all clients.

@dblock dblock added the enhancement New feature or request label Aug 25, 2022
@wbeckler
Copy link

How has this been going for core? If it's hunky dory, it makes sense to raise the bar for client repos.

@dblock
Copy link
Member Author

dblock commented Aug 29, 2022

opensearch-project/OpenSearch#1868

Yep, like so: opensearch-project/OpenSearch#4085 and opensearch-project/OpenSearch#4296

@dblock
Copy link
Member Author

dblock commented Oct 12, 2022

Here's another example why we should do this: opensearch-project/opensearch-js#290 (comment) - user is reading docs that are newer than the released software and I can't tell what was released in the last version vs. what was added since

@harshavamsi
Copy link
Collaborator

This is complete across all clients and can be closed. I'm tracking the discussion in opensearch-project/OpenSearch#4936 and will update the implementation if anything changes.

@dblock
Copy link
Member Author

dblock commented Nov 9, 2022

I noticed we don't do CHANGELOG updates in some dependabot PRs, can we please fix that?

@harshavamsi
Copy link
Collaborator

I noticed we don't do CHANGELOG updates in some dependabot PRs, can we please fix that?

It's weird. We have the dependabot_pr action that should update the changelog if the PR is raised by dependabot. But sometimes we have to manually do a dependabot recreate to get it to update the changelog.

@dblock dblock closed this as completed Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants