Make packaging solution

stringsync / vexml

MusicXML to Vexflow

MIT License

18 stars 5 forks source link

Make packaging solution #136

Open jaredjj3 opened 11 months ago

jaredjj3 commented 11 months ago

We need a mechanism to package and distribute vexml.

It would be nice to have something that generates changelogs automatically using the PR titles. I'm not really sure what the best practices are.
I think it makes sense to have a manual release process.
I'm interested in migrating https://bun.sh/ to run the tests and build, but it looks like they don't have an official mechanism to publish (https://github.com/oven-sh/bun/issues/1976). I think it would be better to just use yarn for now to publish to npm.

rvilarl commented 11 months ago

I am sure that @ronyeh can help us He did a very good job in vexflow

ronyeh commented 11 months ago

Hi!

I mostly copied the packaging / release solution from other projects that I enjoyed using. Feel free to copy the VexFlow approach (inspect package.json, etc). Let me know if you have any questions.

I've heard about bun and it seems promising. You can always use bun to do everything else except release/publish at the moment. We have been using the release-it script to send our VexFlow releases to GitHub and NPM.

ronyeh commented 11 months ago

Our current GitHub changelog looks like this: https://github.com/vexflow/vexflow/releases

release-it handles the changelog for us: https://github.com/release-it/release-it/blob/main/docs/changelog.md

If you figure out a good way to do your change logs, let us know! We might borrow some of your techniques. :-)

sschmidTU commented 11 months ago

OSMD's changelog uses conventional-changelog, a tool that automatically generates changelogs.

The only issue is that you need to use a certain format for commit messages, namely commitizen/angular format, like this: fix(Lyrics): Fix lyrics position or feat(Lyrics): ...

This will generate lines like this:

Bug Fixes

Lyrics: Fix lyrics position (#1267). (52b7116)

In our experience, the hard part is getting all developers to use this commit message convention for major commits (that should appear in the changelog) ;)