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

chore: adds CHANGELOG.md #58

Closed
wants to merge 1 commit into from

Conversation

helio-frota
Copy link
Collaborator

@helio-frota helio-frota commented Feb 12, 2024

Related to #55

  • Generated by convco using this command:

convco changelog --include-hidden-sections > CHANGELOG.md

https://convco.github.io/configuration/#default-configuration

  • Added a .versionrc because it was generated by a fork, and we need to make sure the origin is trustification instead of fork's origin.

* Generated by convco using this command:

`convco changelog --include-hidden-sections > CHANGELOG.md`

https://convco.github.io/configuration/#default-configuration

* Added a `.versionrc` because it was generated by a fork, and
we need to make sure the origin is `trustification` instead of fork's
origin.
@helio-frota helio-frota requested review from dejanb and ctron February 12, 2024 17:05
@ctron
Copy link
Collaborator

ctron commented Feb 13, 2024

I would recommend to:

  • Don't create a CHANGELOG.md file. That only causes merge/rebase conflicts and is a pure annoyance. Putting the generated changelog into a github release section on the other hand is quite helpful.
  • Don't use "link mode", disabling that will let github automatically create links and include nice hovers in addition
  • You can customize the rendered output by customizing the template: https://convco.github.io/changelog/#custom-template

@helio-frota
Copy link
Collaborator Author

I would recommend to:

thanks for the recommendation !

@helio-frota
Copy link
Collaborator Author

Closing and assigned #55 to @dejanb as this will be part of a release process. 👍

@helio-frota helio-frota deleted the changelog branch February 13, 2024 17:00
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.

2 participants