bonvoy 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +117 -0
- package/package.json +52 -0
package/README.md
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# @bonvoy/cli 🚢
|
|
2
|
+
|
|
3
|
+
> CLI for bonvoy release automation
|
|
4
|
+
|
|
5
|
+
Command-line interface for bonvoy - the plugin-based release automation tool for npm packages and monorepos.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- 🚀 **Simple Commands** - Intuitive CLI with `shipit`, `prepare`, `status`
|
|
10
|
+
- 🔍 **Dry Run Mode** - Preview changes before executing
|
|
11
|
+
- 📊 **Rich Output** - Colored output with progress indicators
|
|
12
|
+
- ⚙️ **Flexible Options** - Force version bumps, select packages
|
|
13
|
+
- 🛡️ **Type Safety** - Built with TypeScript and commander.js
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Install globally
|
|
19
|
+
npm install -g @bonvoy/cli
|
|
20
|
+
|
|
21
|
+
# Or use with npx
|
|
22
|
+
npx @bonvoy/cli shipit
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Commands
|
|
26
|
+
|
|
27
|
+
### `shipit` - Release packages
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# Release all changed packages
|
|
31
|
+
bonvoy shipit
|
|
32
|
+
|
|
33
|
+
# Preview changes (dry run)
|
|
34
|
+
bonvoy shipit --dry-run
|
|
35
|
+
|
|
36
|
+
# Output JSON for CI integration
|
|
37
|
+
bonvoy shipit --json
|
|
38
|
+
|
|
39
|
+
# Force specific version bump
|
|
40
|
+
bonvoy shipit patch
|
|
41
|
+
bonvoy shipit minor
|
|
42
|
+
bonvoy shipit major
|
|
43
|
+
bonvoy shipit 2.0.0
|
|
44
|
+
|
|
45
|
+
# Release specific packages
|
|
46
|
+
bonvoy shipit --package @scope/core --package @scope/utils
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### `prepare` - Create release PR
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# Create PR with version bumps and changelog
|
|
53
|
+
bonvoy prepare
|
|
54
|
+
|
|
55
|
+
# Preview PR changes
|
|
56
|
+
bonvoy prepare --dry-run
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### `status` - Show pending changes
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# Show packages with unreleased changes
|
|
63
|
+
bonvoy status
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### `changelog` - Preview changelog
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
# Show changelog for all packages
|
|
70
|
+
bonvoy changelog
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Configuration
|
|
74
|
+
|
|
75
|
+
Create `bonvoy.config.js` in your project root:
|
|
76
|
+
|
|
77
|
+
```javascript
|
|
78
|
+
export default {
|
|
79
|
+
versioning: 'independent',
|
|
80
|
+
commitMessage: 'chore: :bookmark: release',
|
|
81
|
+
tagFormat: '{name}@{version}',
|
|
82
|
+
workflow: 'direct',
|
|
83
|
+
plugins: [
|
|
84
|
+
'@bonvoy/plugin-conventional',
|
|
85
|
+
'@bonvoy/plugin-changelog',
|
|
86
|
+
'@bonvoy/plugin-git',
|
|
87
|
+
'@bonvoy/plugin-npm',
|
|
88
|
+
'@bonvoy/plugin-github',
|
|
89
|
+
],
|
|
90
|
+
};
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Examples
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
# Standard release workflow
|
|
97
|
+
bonvoy shipit
|
|
98
|
+
|
|
99
|
+
# Preview what would happen
|
|
100
|
+
bonvoy shipit --dry-run
|
|
101
|
+
|
|
102
|
+
# Force minor bump for all packages
|
|
103
|
+
bonvoy shipit minor
|
|
104
|
+
|
|
105
|
+
# Release only specific packages
|
|
106
|
+
bonvoy shipit --package @myorg/core --package @myorg/utils
|
|
107
|
+
|
|
108
|
+
# Create release PR instead of direct release
|
|
109
|
+
bonvoy prepare
|
|
110
|
+
|
|
111
|
+
# Check what packages have changes
|
|
112
|
+
bonvoy status
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## License
|
|
116
|
+
|
|
117
|
+
MIT
|
package/package.json
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "bonvoy",
|
|
3
|
+
"version": "0.7.0",
|
|
4
|
+
"description": "🚢 CLI for bonvoy release automation",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"release",
|
|
7
|
+
"automation",
|
|
8
|
+
"cli",
|
|
9
|
+
"monorepo"
|
|
10
|
+
],
|
|
11
|
+
"homepage": "https://github.com/Zweer/bonvoy#readme",
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/Zweer/bonvoy/issues"
|
|
14
|
+
},
|
|
15
|
+
"repository": {
|
|
16
|
+
"type": "git",
|
|
17
|
+
"url": "git+https://github.com/Zweer/bonvoy.git",
|
|
18
|
+
"directory": "packages/cli"
|
|
19
|
+
},
|
|
20
|
+
"license": "MIT",
|
|
21
|
+
"author": {
|
|
22
|
+
"name": "Zweer",
|
|
23
|
+
"email": "n.olivieriachille@gmail.com"
|
|
24
|
+
},
|
|
25
|
+
"type": "module",
|
|
26
|
+
"exports": {
|
|
27
|
+
".": "./dist/index.mjs",
|
|
28
|
+
"./package.json": "./package.json"
|
|
29
|
+
},
|
|
30
|
+
"bin": {
|
|
31
|
+
"bonvoy": "dist/index.mjs"
|
|
32
|
+
},
|
|
33
|
+
"files": [
|
|
34
|
+
"dist"
|
|
35
|
+
],
|
|
36
|
+
"dependencies": {
|
|
37
|
+
"@bonvoy/core": "^0.6.0",
|
|
38
|
+
"@bonvoy/plugin-changelog": "^0.1.1",
|
|
39
|
+
"@bonvoy/plugin-conventional": "^0.1.1",
|
|
40
|
+
"@bonvoy/plugin-git": "^0.5.0",
|
|
41
|
+
"@bonvoy/plugin-github": "^0.4.0",
|
|
42
|
+
"@bonvoy/plugin-gitlab": "^0.2.2",
|
|
43
|
+
"@bonvoy/plugin-npm": "^0.3.0",
|
|
44
|
+
"@commander-js/extra-typings": "^14.0.0",
|
|
45
|
+
"commander": "^14.0.3",
|
|
46
|
+
"execa": "^9.6.1",
|
|
47
|
+
"semver": "^7.7.4"
|
|
48
|
+
},
|
|
49
|
+
"engines": {
|
|
50
|
+
"node": ">=20.5"
|
|
51
|
+
}
|
|
52
|
+
}
|