🚀 Template repository for package maintenance and publishing
MIT License
🚀 Template repository for package maintenance and publishing.
As I got tired of creating the same file structure for quick library scaffolding and package publishing, I decided to do a repository tempalte I (and you) can use every time I start a new project.
It's important to note that the workflows are highly opinionated around my preferences when pushing minimal and not-complex packages to the ecosystem, this means it might not feed or adapt to your needs, but feel free to start a discussion in the issues inc ase there are things you would like to see or improve.
This template is relying on other great open source projects to achieve normal project cycles.
.test
or .spec
file in the project.Read more about how to ensure this works correctly in the Initial Setup section.
To make sure the automatic publishing works correctly follow these initial steps:
yarn
to install dependencies.package.json
file replace package-starter
with your project name and the rest of the information like description, author, repository, etc.npm publish
, tag the release with git tag "v0.0.0"
and then git push origin master --tags
, this is important since semantic release relies on tags to know what's the next version to publish.NPM_TOKEN
and a GITHUB_TOKEN
to allow package publishing on every push to master.Now, let conventional commit messages and semantic release to handle all the publishing for you!
Happy coding!
By the default the template includes a MIT License, feel free to change it for the one that suits better the legal needs of your project.