Add a changelog

[bluepnume]

Plenty of people using this now... can't do it cowboy style any more!

[harouny]

Hey @bluepnume
We currently have v 2 in production for couple of projects. We need to have the list of breaking changes / new features before we can upgrade. Is that something you would be doing?

[bluepnume]

Hey @harouny -- sorry for the delay on this, been tied up with a bunch of high priority things.

I'll add a changelog soon, but for now the only breaking change with v3 was to do with the containerTemplate and componentTemplate options.

Instead of passing a string, the recommended approach is now to pass a DOM element (to which you can attach your own events rather than using things like class="${CLASS.CLOSE}".

There's an example here -- https://github.com/krakenjs/xcomponent/blob/master/demo/basic/lightbox/login.js#L14-L113

But let me know if you're using either of those options and I can help you migrate if needed.

[twig]

We've recently put xcomponent into production and surprised to see multiple releases in the past 2 days!

Would not be able to keep up with development at this rate without change logs.

[apuntovanini]

Any news on Changelog? v8 came out with no clues yet
Thanks!

[joseluis-fw]

It will be nice at least to have the PR description and closed issues between releases. Was difficult to link this to this commit in master.

[apuntovanini]

@bluepnume I do love Zoid, but with no changelog is so difficult to understand what's going on. Why not using @changesets or automatic changelog generators? Open to PR?

[bluepnume]

Hi @apuntovanini — definitely open to PRs!

[rafaeelaudibert]

Hey @bluepnume, would you assign this to me? I think we could create the CHANGELOG differently than what was proposed before. I'd use a Github action to create it so that every time we create a tag, we would automatically generate a Github Release with its changelog attached (like most of the libs are doing nowadays). WDYT?

I'd probably use this action.

[mstuart]

That would be great! Thanks @rafaeelaudibert. Assigning to you

[ghost]

Or may be this. https://github.blog/2021-10-04-beta-github-releases-improving-release-experience/

[rafaeelaudibert]

I've thought about using this @sibiraj-sr, but it is pretty new, and it would need some manual work, with the maintainers needing to manually create the release.

@mstuart, could you check the PR? #373