Skip to content

Commit

Permalink
chore: add badges and note about release process
Browse files Browse the repository at this point in the history
  • Loading branch information
fmal committed Oct 11, 2019
1 parent 1ea80e2 commit b9a21d3
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# monorepo

[![Build Status](https://img.shields.io/travis/fmal/monorepo.svg)](https://travis-ci.org/fmal/monorepo)
[![Coverage](https://codecov.io/gh/fmal/monorepo/branch/master/graph/badge.svg)](https://codecov.io/gh/fmal/monorepo)
[![maintained with repo cooker](https://img.shields.io/badge/maintained%20with-repo%20cooker-cc00ff.svg)](https://github.com/cerebral/repo-cooker)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

📦 A monorepo for my NPM libraries.
Managed with [repo-cooker](https://github.com/cerebral/repo-cooker) library.
Using [Jest](https://github.com/facebook/jest), [eslint](https://github.com/eslint/eslint), [prettier](https://github.com/prettier/prettier) and TypeScript through [babel](https://github.com/babel/babel) 7. Semantically versioned and automatically released, following [conventional-commits](https://github.com/conventional-commits/conventionalcommits.org)!
Expand All @@ -18,3 +24,11 @@ Using [Jest](https://github.com/facebook/jest), [eslint](https://github.com/esli
- `npm run link` an alias for `repo-cooker --link` which symlinks dependencies. This is automatically run through the `postinstall` hook when you do `npm install`

To compile source or run tests for an individual package, `npm run build` or `npm run test` from the package root.

## Release process

When you push commits to the `next` branch repo-cooker will create a beta release which you can install with `npm install yourpackage@next`.

When pushing to the `master` branch repo-cooker creates a stable release with release notes retrieved from the commit messages.

Commits with the `fix` type trigger a patch version release, commits with `feat` type a minor version release and commits with breaking changes a major version release. Commits containing other types will not trigger any release.

0 comments on commit b9a21d3

Please sign in to comment.