search

GeotrekCE / Geotrek-rando-widget

Web components to display Geotrek content on any website
https://geotrek-rando-widget.readthedocs.io
MIT License
6 stars 1 forks source link

Add Changelog #82

Closed babastienne closed 7 months ago

babastienne commented 7 months ago

Add file with changelog and updates sorted by release.

This file should be listed in the documentation as well.

You can take copy the style of the changelog used in geotrek-admin or geotrek-rando-v3.

It should list new features, breaking changes, updates in configuration, enhancements, bugfix, maintenance, etc.

Each new pull request should update the changelog accordingly with the modifications.

bastyen commented 7 months ago

ce21944fac44574d751a7bb808c14ffdd609f430

babastienne commented 7 months ago

Can you explain more the procedure ? Where is the changelog, how can we maintain it ?

bastyen commented 7 months ago

The changelog is created automatically by release-please-action. It's based on Conventional Commit Messages. You can look at the pull requests tab to find the PR for the next release.

babastienne commented 7 months ago

Ok I think I get it now. So each time you want to do a release you'll need to open a PR like #85 ?

bastyen commented 7 months ago

When i will merge this PR, a release will be created. This action handle the versioning based on commits.

  • fix: which represents bug fixes, and correlates to a SemVer patch.
  • feat: which represents a new feature, and correlates to a SemVer minor.
  • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

Then a new PR will be created automatically by this action when there will be a new commit.