Changelog, versioning and upgrading

[jbmoelker]

User story

As a developer using Head Start for my project,
I want a clear list of changes when there's a newer version of Head Start available,
so that I know if it's worth (new features vs breaking changes) updating my project to a newer version.

[jbmoelker]

Since Head Start is a starterkit template rather than a package, semver might not be most suitable. As basically every change is an API change. Maybe we can still use Changesets, but with a custom changelog format so our CHANGELOG.md could look something like this:

# Head Start Changelog

## 2024-01-31 <!-- date of merge to main, rather than semver -->

* [#30](https://github.com/voorhoede/head-start/pull/30) adds new Table Block, see its readme for details.
* [#127](https://github.com/voorhoede/head-start/pull/127) fix routing in Preview Mode, ...

## 2024-01-16

* ...

[jbmoelker]

The changelog format as proposed in the previous comment basically already exists, as it matches the commits of the PRs merged to main:

It has the added bonus that you can filter by date range.

So instead, documenting how to make a patch as proposed in the original issue description could suffice.

[jbmoelker]

Another alternative is using git cherry-picking desired changes one by one or git cherry-picking a whole range of commits. Where the Head Start repository can be added as a secondary remote (git remote add head-start [email protected]:voorhoede/head-start.git).