Skip to content

Commit

Permalink
docs: update badges
Browse files Browse the repository at this point in the history
  • Loading branch information
tscpp committed Jun 24, 2024
1 parent 31f4dd4 commit 04152b5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Conventional Versioning

[![NPM Version](https://img.shields.io/npm/v/conventional-versioning)](https://npmjs.com/package/conventional-versioning)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/tscpp/conventional-versioning/checks.yml)
[![NPM Version](https://img.shields.io/npm/v/conventional-versioning?color=red)](https://npmjs.com/package/conventional-versioning)
[![NPM Downloads](https://img.shields.io/npm/dm/conventional-versioning?color=blue)
](https://www.npmjs.com/package/conventional-versioning)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/tscpp/conventional-versioning/checks.yml?label=checks)](https://github.com/tscpp/conventional-versioning/actions/workflows/checks.yml)

## Introduction

Expand Down Expand Up @@ -116,12 +118,12 @@ You can specify which packages or patterns of packages to include or exclude fro
"@some-scope/*",
// And also these packages
"a",
"b"
"b",
],
// And exclude all packages under @other-scope/.
"exclude": ["@other-scope/*"],
// Also exclude all private packages.
"ignorePrivatePackages": true
"ignorePrivatePackages": true,
}
```

Expand All @@ -133,8 +135,8 @@ You can specify custom mapping from conventional commit types to the version bum
{
"bumps": {
// Commit "addition: some features" will infer a minor bump for affected packages.
"addition": "minor"
}
"addition": "minor",
},
}
```

Expand All @@ -146,12 +148,12 @@ There are two methods for linking packages. `linked` ensures that all major and
{
"linked": [
// Will release with same minor.
["a", "b"]
["a", "b"],
],
"fixed": [
// Will release with same patch.
["c", "d"]
]
["c", "d"],
],
}
```

Expand Down
3 changes: 3 additions & 0 deletions conver.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,8 @@
"branch": "main",
"base": "037cce8ad32e9ed9022b80f3089848583f9aac1a",
"original": {
},
"promotions": {
"conventional-versioning": "patch"
}
}

0 comments on commit 04152b5

Please sign in to comment.