Include a changelog for the specification itself #66

Open
opened 2026-02-17 11:41:29 -06:00 by GiteaMirror · 7 comments
Owner

Originally created by @eemeli on GitHub (Apr 17, 2019).

I guess this counts as a bit of a request for dogfooding?

I am using conventional-commits and tools based on it. Currently, when I notice that the website's version has updated itself, I need to look through the commits on GitHub to find out what happened. This is clumsy. What I expected to find was a changelog available somewhere that would summarise the changes for me; this is effectively the most significant reason why I'm encouraging developers around me to use the spec in the first place.

Or did I just not find the changelog, and this is really a request for linking to it more clearly?

Originally created by @eemeli on GitHub (Apr 17, 2019). I guess this counts as a bit of a request for dogfooding? I am using conventional-commits and tools based on it. Currently, when I notice that the website's version has updated itself, I need to look through the commits on GitHub to find out what happened. This is clumsy. What I expected to find was a changelog available somewhere that would summarise the changes for me; this is effectively the most significant reason why I'm encouraging developers around me to use the spec in the first place. Or did I just not find the changelog, and this is really a request for linking to it more clearly?
GiteaMirror added the enhancement label 2026-02-17 11:41:29 -06:00
Author
Owner

@bcoe commented on GitHub (Apr 17, 2019):

@eemeli great point 👍 the cobblers children have no shoes?

Would happily accept a PR adding a CHANGELOG, standard-verison is what I use on all my libraries ... and it's about to have a PR lands that makes it compliant with the latest and greatest rules we're describing in this specification.

@bcoe commented on GitHub (Apr 17, 2019): @eemeli great point :+1: the cobblers children have no shoes? Would happily accept a PR adding a CHANGELOG, [standard-verison](https://github.com/conventional-changelog/standard-version) is what I use on all my libraries ... and it's about to have a PR lands that makes it compliant with the latest and greatest rules we're describing in this specification.
Author
Owner

@damianopetrungaro commented on GitHub (Jul 4, 2019):

@eemeli do you want to work on it?

@damianopetrungaro commented on GitHub (Jul 4, 2019): @eemeli do you want to work on it?
Author
Owner

@eemeli commented on GitHub (Jul 4, 2019):

@damianopetrungaro I'm afraid I don't really have the bandwidth available for this atm.

@eemeli commented on GitHub (Jul 4, 2019): @damianopetrungaro I'm afraid I don't really have the bandwidth available for this atm.
Author
Owner

@bcoe commented on GitHub (Jul 8, 2019):

@damianopetrungaro I'd be happy to take this on, I think we need to come up with some guidelines for how we tag the different variety of commits to this repo however; as working on a spec document is a bit different than a module ... almost every change could be argued to be docs.

@bcoe commented on GitHub (Jul 8, 2019): @damianopetrungaro I'd be happy to take this on, I think we need to come up with some guidelines for how we tag the different variety of commits to this repo however; as working on a spec document is a bit different than a module ... almost every change could be argued to be `docs`.
Author
Owner

@rbalet commented on GitHub (Apr 24, 2025):

Hey @bcoe would you still be open to merge a PR in case I was willing to do one ?
I could do one of the both

A: Conventional changelog

  1. use the following library : https://github.com/conventional-changelog/conventional-changelog
  2. Add a release script inside the package.json file

B: Release please & GitHub

  1. Creating the release-please.yml required file
  2. Asking you guys to activate the release-please-action over on the GitHub repo

Note: never tried release please but seems pretty simple

Cheers

@rbalet commented on GitHub (Apr 24, 2025): Hey @bcoe would you still be open to merge a PR in case I was willing to do one ? I could do one of the both ## A: Conventional changelog 1. use the following library : https://github.com/conventional-changelog/conventional-changelog 2. Add a `release script` inside the `package.json` file ## B: Release please & GitHub 1. Creating the `release-please.yml` required file 2. Asking you guys to activate the [release-please-action](https://github.com/googleapis/release-please-action) over on the GitHub repo _Note: never tried release please but seems pretty simple_ Cheers
Author
Owner

@bcoe commented on GitHub (May 2, 2025):

@rbalet yes I would be open to adding a release process, and would be appreciative of a PR.

@bcoe commented on GitHub (May 2, 2025): @rbalet yes I would be open to adding a release process, and would be appreciative of a PR.
Author
Owner

@rbalet commented on GitHub (May 16, 2025):

@bcoe Nice I'll get to it in the following days.

Is the actual state ready for you to be the v1.0.0 ?
If yes, could you add a new v1.0.0 tag in the master branch ?

Then I'll be able to prepare the changelog with his automation.
Cheers!

@rbalet commented on GitHub (May 16, 2025): @bcoe Nice I'll get to it in the following days. Is the actual state ready for you to be the v1.0.0 ? If yes, could you add a new `v1.0.0` tag in the master branch ? Then I'll be able to prepare the changelog with his automation. Cheers!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/conventionalcommits.org#66