Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.31 KB

README.md

File metadata and controls

23 lines (12 loc) · 1.31 KB
Raw

Lerna Release Workflow

A basic Lerna monorepo with Yarn Workspaces, Conventional Commits and GitHub Actions workflow configuration to achieve fully automated package publishing to the GitHub Package Registry.

Create a new repository from this template

Click the Use this template button and provide the new repository details.

Getting Started

Let's start by setting up the new repository:

  1. Update the root package.json with your repository name and url.

  2. Modify the sample packages as needed and remember to update their package.json.

    NOTE: For a package to be releasable to GitHub Package Registry, it must be scoped to match the owner of the repository. The package name is optional, as long as it is unique under that scope. In addition, the repository.url field needs to be consistent in all package.json files.

  3. Run yarn bootstrap to bootstrap the packages. This will install all of their dependencies and links any cross-dependencies.

How it works

Each push to master branch will generate a version number, git tag, Conventional Changelog, release commit, pushing changes to the origin and publish to GitHub Package Registry.