Skip to content

CHANGELOG.md: order into a more user-first ordering. #5723

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

Merged
merged 2 commits into from
Nov 25, 2022

Conversation

rustyrussell
Copy link
Contributor

And internal changes don't get CHANGELOG entries, so removed "- Added interactive transaction building routine ([#5287])".

We need to come up with some way of marking rust crate changes, as it's not immediately obvious what "- cln-plugin" means?

Maybe we switch from JSON-RPC to Control as a more general prefix?

Changelog-None

@rustyrussell rustyrussell added this to the v22.11 milestone Nov 19, 2022
Copy link
Collaborator

@vincenzopalazzo vincenzopalazzo left a comment

Choose a reason for hiding this comment

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

ACK d9f5ca0

regarding the rust and python changes what about putting a filter in front of Changelog-None(rust-grpc) in this way from the git history, we can generate the changelog by scope. I had a tool that already do this but required some more love to be shipped with cln. But if you want I can spend some time testing it and we will see if it is possible to integrate it. I think should be trivial, I use it in all monorepo repositories and make the job

@rustyrussell
Copy link
Contributor Author

I think the simple prefix is correct, but our prefix choices need work. We're not just JSON any more: perhaps we should change this to simply API?

@vincenzopalazzo
Copy link
Collaborator

vincenzopalazzo commented Nov 20, 2022

I agree!

I think the simple prefix is correct, but our prefix choices need work. We're not just JSON any more: perhaps we should change this to simply API?

Yes, I think have a section regarding the API added and changed would be really interesting for the user that just does not care really about the internal.

I would also propose that we should generate our own changelog for the python client package and rust packages, because right now the changes are a little bit hide in the darkness of cln changes

And internal changes don't get CHANGELOG entries, so removed
"- Added interactive transaction building routine ([ElementsProject#5287])".

We need to come up with some way of marking rust crate changes,
as it's not immediately obvious what "- cln-plugin" means?

Maybe we switch from JSON-RPC to Control as a more general
prefix?

Signed-off-by: Rusty Russell <[email protected]>
This should have been merged into master earlier!

Signed-off-by: Rusty Russell <[email protected]>
@cdecker
Copy link
Member

cdecker commented Nov 25, 2022

ACK e937c82

@cdecker cdecker merged commit 8ebde45 into ElementsProject:master Nov 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants