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

auto-generate changelog? #109

Closed
vobu opened this issue Jul 15, 2023 · 2 comments
Closed

auto-generate changelog? #109

vobu opened this issue Jul 15, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@vobu
Copy link
Collaborator

vobu commented Jul 15, 2023

hi, gathering opinions here: waddaya think about enforcing commit msg formats to generate a changelog from them? this is how we do it with wdi5 and it's working well.
downside is more self discipline necessary on the dev side, upside is an automated and very clean and sleek looking doc.

@patricebender
Copy link
Member

patricebender commented Jul 27, 2023

idea

  • open PR with a clear and concise title which will then be added to the changelog
  • labels postgres , sqlite, db-service will determine to which changelog the entry will be added to
  • labels fix, feature, change, remove will determine in which category the entry will be added to
  • also link the pull request in the changelog entry via link

maybe use release please

@patricebender patricebender added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jul 27, 2023
patricebender added a commit that referenced this issue Oct 11, 2023
follow steps in https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md which is targeting monorepo setups.

To use release please we need to install the `release-please` npm package: `npm i release-please -g`.

work for #109

---

inspired by https://github.com/Financial-Times/origami → those guys are releasing dozens of components from their monorepo with `release-please`
@patricebender
Copy link
Member

Implemented by #272 ff and #281, see e.g. #303 and the resulting release tag https://github.com/cap-js/cds-dbs/releases/tag/db-service-v1.3.2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants