Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make packaging solution #136

Open
jaredjj3 opened this issue Oct 8, 2023 · 4 comments
Open

Make packaging solution #136

jaredjj3 opened this issue Oct 8, 2023 · 4 comments

Comments

@jaredjj3
Copy link
Collaborator

jaredjj3 commented Oct 8, 2023

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 (Implement bun publish oven-sh/bun#1976). I think it would be better to just use yarn for now to publish to npm.
@jaredjj3 jaredjj3 changed the title Determine packaging solution Make packaging solution Oct 8, 2023
@rvilarl
Copy link
Collaborator

rvilarl commented Oct 8, 2023

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

@ronyeh
Copy link

ronyeh commented Oct 9, 2023

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
Copy link

ronyeh commented Oct 9, 2023

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
Copy link

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

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) ;)

@jaredjj3 jaredjj3 mentioned this issue Nov 16, 2023
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants