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

docs: add a changelog file for the neon cli #287

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

danieltprice
Copy link
Contributor

@danieltprice danieltprice commented Oct 7, 2024

I'd like to propose that we start keeping a changelog file for the Neon CLI. It will be helpful to reference this from the Docs and elsewhere. Ideally, we'll automate this as a next step, but I'd like to find an automated approach that we can use for all repos.

@danieltprice danieltprice changed the title Add a changelog file for the Neon CLI docs: add a changelog file for the neon cli Oct 7, 2024
@alexfedosov
Copy link
Contributor

alexfedosov commented Oct 7, 2024

I don't mind, but I'm not sure what value it adds compared to looking at the releases pages.
For example: https://github.com/neondatabase/neonctl/releases/tag/v2.0.0

The downside, however, is that it requires following one more process that can be automated. Maybe we can try to keep descriptions on the releases page nice and tidy instead?

For instance:
image

@duskpoet
Copy link
Member

duskpoet commented Oct 7, 2024

we have the semantic bot that generates release descriptions, we also have the committing watching so commits are following the conventional commits spec. We can reference releases or commits from docs, wouldn't that work?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants