Package Modernization

[nzakas]

The first priority for getting this package into a state where we can make changes is to go through and modernize the repo. Here are the steps:

• Switch the primary branch to main
• Set up automated CI testing using GitHub actions (separate lint and test steps)
• Enforce conventional commits formats on pull requests
• Update all dependencies to latest
• Set up a release process

[MarkKragerup]

@nzakas this is awesome. This is what i was in the process of doing on the fork. I'll dig into whatever remains on this issue monday.

[nzakas]

@MarkKragerup Awesome, thank you! 🙏

[nzakas]

For the release process, I'm thinking of using release-please. I'm curious if others have experience with other systems that they might prefer?

[UziTech]

I like semantic-release

[UziTech]

You might also want to look at renovate for automated dependency updates.

[nzakas]

Thanks @UziTech. I'm not very familiar with semantic-release, but it looks like there's still a need to manually run a release? With release-please, it creates a PR that you merge and then a release is triggered, so it's completely hands-off.

@nlf it looks like I don't have permissions to create secrets in this repo. Would it be possible to add me as an admin? If not, would you be able to set up a secret called NPM_TOKEN that contains an npm CI token to use for publishing?

[UziTech]

semantic-release does automatically release as well as update changeling. I've never used release please but it looks like the main difference is that release please adds a PR that needs to be submitted to do a release where semantic-release just releases each commit that bumps the version.

[nzakas]

Ah gotcha. It still looks like semantic-release gets a bit difficult with protected branches? (In terms of updating package.json and then pushing it back to the repo.)

[nzakas]

@darcyclarke @nlf I'm unable to set up any secrets for this repo with the maintainer role. Would it be possible to set me as the owner? Otherwise, I'm stuck doing releases by hand.

[nzakas]

Now that we've moved the repo, this is complete. 🎉