gitverse-release 2.0.0 → 2.0.1
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 +94 -145
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,67 +1,66 @@
|
|
|
1
1
|
# @gitverse/release
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> Automated release tool for GitVerse repositories with Conventional Commits support
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@gitverse/release)
|
|
6
6
|
[](https://opensource.org/licenses/MIT)
|
|
7
|
-
[](./COVERAGE.md)
|
|
8
7
|
|
|
9
|
-
##
|
|
8
|
+
## Features
|
|
10
9
|
|
|
11
|
-
- > **2B><0B8G5A:>5 25@A8>=8@>20=85** =0 >A=>25 Conventional Commits
|
|
12
|
-
- =� **5=5@0F8O CHANGELOG** A 3@C??8@>2:>9 ?> B8?0< :><<8B>2
|
|
13
|
-
- < **=B53@0F8O A GitVerse API** 4;O A>740=8O @5;87>2
|
|
14
|
-
- =� ** >445@6:0 <>=>@5?>78B>@852** A =57028A8<K< 25@A8>=8@>20=85<
|
|
15
|
-
- <� **2B><0B8G5A:>5 A>740=85** git B53>2 8 :><<8B>2
|
|
16
|
-
- =
|
|
17
10
|
** 568< dry-run** 4;O 157>?0A=>3> B5AB8@>20=8O
|
|
18
|
-
-
|
|
11
|
+
- ✅ **Automatic versioning** based on Conventional Commits
|
|
12
|
+
- 📝 **CHANGELOG generation** grouped by commit types
|
|
13
|
+
- 🌐 **GitVerse API integration** for creating releases
|
|
14
|
+
- 📦 **Monorepo support** with independent versioning
|
|
15
|
+
- 🏷️ **Automatic git tags and commits**
|
|
16
|
+
- 🔍 **Dry-run mode** for safe testing
|
|
17
|
+
- ⚙️ **Flexible configuration** via `.gitversereleaserc.json`
|
|
19
18
|
|
|
20
|
-
##
|
|
19
|
+
## Installation
|
|
21
20
|
|
|
22
21
|
```bash
|
|
23
|
-
#
|
|
22
|
+
# Using npm
|
|
24
23
|
npm install -D @gitverse/release
|
|
25
24
|
|
|
26
|
-
#
|
|
25
|
+
# Using bun
|
|
27
26
|
bun add -d @gitverse/release
|
|
28
27
|
|
|
29
|
-
#
|
|
28
|
+
# Using yarn
|
|
30
29
|
yarn add -D @gitverse/release
|
|
31
30
|
|
|
32
|
-
#
|
|
31
|
+
# Using pnpm
|
|
33
32
|
pnpm add -D @gitverse/release
|
|
34
33
|
```
|
|
35
34
|
|
|
36
|
-
##
|
|
35
|
+
## Quick Start
|
|
37
36
|
|
|
38
|
-
### 1.
|
|
37
|
+
### 1. Basic Usage
|
|
39
38
|
|
|
40
39
|
```bash
|
|
41
|
-
#
|
|
40
|
+
# Create release (dry-run for testing)
|
|
42
41
|
npx @gitverse/release --dry-run
|
|
43
42
|
|
|
44
|
-
#
|
|
43
|
+
# Create and publish release
|
|
45
44
|
npx @gitverse/release
|
|
46
45
|
```
|
|
47
46
|
|
|
48
|
-
### 2.
|
|
47
|
+
### 2. Configuration
|
|
49
48
|
|
|
50
|
-
|
|
49
|
+
Create `.gitversereleaserc.json` in project root:
|
|
51
50
|
|
|
52
51
|
```json
|
|
53
52
|
{
|
|
54
53
|
"git": {
|
|
55
|
-
"commitMessage": "chore(release):
|
|
54
|
+
"commitMessage": "chore(release): v{version} [skip ci]",
|
|
56
55
|
"tagMessage": "Release {version}",
|
|
57
56
|
"push": true,
|
|
58
57
|
"commitChanges": true
|
|
59
58
|
},
|
|
60
59
|
"changelog": {
|
|
61
60
|
"types": {
|
|
62
|
-
"feat": "
|
|
63
|
-
"fix": "
|
|
64
|
-
"perf": "
|
|
65
|
-
"docs": "
|
|
61
|
+
"feat": "✨ Features",
|
|
62
|
+
"fix": "🐛 Bug Fixes",
|
|
63
|
+
"perf": "⚡ Performance",
|
|
64
|
+
"docs": "📝 Documentation"
|
|
66
65
|
},
|
|
67
66
|
"showHash": true,
|
|
68
67
|
"showAuthor": true
|
|
@@ -72,7 +71,7 @@ npx @gitverse/release
|
|
|
72
71
|
}
|
|
73
72
|
```
|
|
74
73
|
|
|
75
|
-
### 3.
|
|
74
|
+
### 3. Add to package.json
|
|
76
75
|
|
|
77
76
|
```json
|
|
78
77
|
{
|
|
@@ -83,55 +82,55 @@ npx @gitverse/release
|
|
|
83
82
|
}
|
|
84
83
|
```
|
|
85
84
|
|
|
86
|
-
##
|
|
85
|
+
## Usage
|
|
87
86
|
|
|
88
87
|
### Conventional Commits
|
|
89
88
|
|
|
90
|
-
|
|
89
|
+
The package automatically determines version bump based on commits:
|
|
91
90
|
|
|
92
91
|
```bash
|
|
93
|
-
# Patch (1.0.0
|
|
94
|
-
git commit -m "fix:
|
|
92
|
+
# Patch (1.0.0 → 1.0.1)
|
|
93
|
+
git commit -m "fix: resolve validation error"
|
|
95
94
|
|
|
96
|
-
# Minor (1.0.0
|
|
97
|
-
git commit -m "feat:
|
|
95
|
+
# Minor (1.0.0 → 1.1.0)
|
|
96
|
+
git commit -m "feat: add new API endpoint"
|
|
98
97
|
|
|
99
|
-
# Major (1.0.0
|
|
100
|
-
git commit -m "feat!:
|
|
101
|
-
#
|
|
102
|
-
git commit -m "feat:
|
|
98
|
+
# Major (1.0.0 → 2.0.0)
|
|
99
|
+
git commit -m "feat!: change API response format"
|
|
100
|
+
# or
|
|
101
|
+
git commit -m "feat: new feature
|
|
103
102
|
|
|
104
|
-
BREAKING CHANGE:
|
|
103
|
+
BREAKING CHANGE: changed configuration format"
|
|
105
104
|
```
|
|
106
105
|
|
|
107
|
-
###
|
|
106
|
+
### Programmatic Usage
|
|
108
107
|
|
|
109
108
|
```typescript
|
|
110
109
|
import { release } from "@gitverse/release";
|
|
111
110
|
|
|
112
|
-
//
|
|
111
|
+
// Simple release
|
|
113
112
|
const result = await release();
|
|
114
113
|
|
|
115
114
|
console.log(result.success); // true
|
|
116
115
|
console.log(result.newVersion); // "1.1.0"
|
|
117
116
|
console.log(result.tag); // "v1.1.0"
|
|
118
117
|
|
|
119
|
-
//
|
|
118
|
+
// With options
|
|
120
119
|
const result = await release(undefined, {
|
|
121
120
|
dryRun: true,
|
|
122
121
|
version: "2.0.0",
|
|
123
122
|
skipGitStatusCheck: false,
|
|
124
123
|
});
|
|
125
124
|
|
|
126
|
-
//
|
|
125
|
+
// For monorepo
|
|
127
126
|
const result = await release("my-package", {
|
|
128
127
|
dryRun: false,
|
|
129
128
|
});
|
|
130
129
|
```
|
|
131
130
|
|
|
132
|
-
##
|
|
131
|
+
## Monorepo Support
|
|
133
132
|
|
|
134
|
-
###
|
|
133
|
+
### Configuration
|
|
135
134
|
|
|
136
135
|
```json
|
|
137
136
|
{
|
|
@@ -157,53 +156,53 @@ const result = await release("my-package", {
|
|
|
157
156
|
}
|
|
158
157
|
```
|
|
159
158
|
|
|
160
|
-
###
|
|
159
|
+
### Usage
|
|
161
160
|
|
|
162
161
|
```bash
|
|
163
|
-
#
|
|
162
|
+
# Release specific package
|
|
164
163
|
npx @gitverse/release core
|
|
165
164
|
|
|
166
|
-
# Dry-run
|
|
165
|
+
# Dry-run for package
|
|
167
166
|
npx @gitverse/release ui --dry-run
|
|
168
167
|
```
|
|
169
168
|
|
|
170
|
-
###
|
|
169
|
+
### Commit Filtering by Scope
|
|
171
170
|
|
|
172
171
|
```bash
|
|
173
|
-
#
|
|
174
|
-
git commit -m "feat(core):
|
|
172
|
+
# Commits for "core" package
|
|
173
|
+
git commit -m "feat(core): add new function"
|
|
175
174
|
|
|
176
|
-
#
|
|
177
|
-
git commit -m "fix(ui):
|
|
175
|
+
# Commits for "ui" package
|
|
176
|
+
git commit -m "fix(ui): resolve component bug"
|
|
178
177
|
|
|
179
|
-
#
|
|
180
|
-
git commit -m "chore:
|
|
178
|
+
# Common commits (affect all packages)
|
|
179
|
+
git commit -m "chore: update dependencies"
|
|
181
180
|
```
|
|
182
181
|
|
|
183
|
-
##
|
|
182
|
+
## Configuration
|
|
184
183
|
|
|
185
|
-
###
|
|
184
|
+
### Full Example
|
|
186
185
|
|
|
187
186
|
```json
|
|
188
187
|
{
|
|
189
188
|
"git": {
|
|
190
|
-
"commitMessage": "chore(release):
|
|
189
|
+
"commitMessage": "chore(release): v{version} [skip ci]",
|
|
191
190
|
"tagMessage": "Release {version}",
|
|
192
191
|
"push": true,
|
|
193
192
|
"commitChanges": true
|
|
194
193
|
},
|
|
195
194
|
"changelog": {
|
|
196
195
|
"types": {
|
|
197
|
-
"feat": "
|
|
198
|
-
"fix": "
|
|
199
|
-
"perf": "
|
|
200
|
-
"refactor": "
|
|
201
|
-
"docs": "
|
|
202
|
-
"style": "
|
|
203
|
-
"test": "
|
|
204
|
-
"build": "
|
|
205
|
-
"ci": "
|
|
206
|
-
"chore": "
|
|
196
|
+
"feat": "✨ Features",
|
|
197
|
+
"fix": "🐛 Bug Fixes",
|
|
198
|
+
"perf": "⚡ Performance Improvements",
|
|
199
|
+
"refactor": "♻️ Code Refactoring",
|
|
200
|
+
"docs": "📝 Documentation",
|
|
201
|
+
"style": "💄 Styles",
|
|
202
|
+
"test": "✅ Tests",
|
|
203
|
+
"build": "🔧 Build System",
|
|
204
|
+
"ci": "👷 CI/CD",
|
|
205
|
+
"chore": "🧹 Chores"
|
|
207
206
|
},
|
|
208
207
|
"showHash": true,
|
|
209
208
|
"showAuthor": true
|
|
@@ -224,83 +223,34 @@ git commit -m "chore: >1=>2;5=K 7028A8<>AB8"
|
|
|
224
223
|
}
|
|
225
224
|
```
|
|
226
225
|
|
|
227
|
-
###
|
|
226
|
+
### Environment Variables
|
|
228
227
|
|
|
229
228
|
```bash
|
|
230
|
-
# GitVerse
|
|
229
|
+
# GitVerse token for creating releases
|
|
231
230
|
export GITVERSE_TOKEN="your-token-here"
|
|
232
231
|
|
|
233
|
-
#
|
|
232
|
+
# Or via .env file
|
|
234
233
|
echo "GITVERSE_TOKEN=your-token" >> .env
|
|
235
234
|
```
|
|
236
235
|
|
|
237
|
-
## =
|
|
238
236
|
?F88 :><0=4=>9 AB@>:8
|
|
239
|
-
|
|
240
|
-
```bash
|
|
241
|
-
npx @gitverse/release [package] [options]
|
|
242
|
-
|
|
243
|
-
@3C<5=BK:
|
|
244
|
-
package <O ?0:5B0 4;O @5;870 (4;O <>=>@5?>78B>@852)
|
|
245
|
-
|
|
246
|
-
?F88:
|
|
247
|
-
--dry-run 0?CAB8BL 157 2=5A5=8O 87<5=5=89
|
|
248
|
-
--version <version> #:070BL :>=:@5B=CN 25@A8N
|
|
249
|
-
--skip-git-check @>?CAB8BL ?@>25@:C G8AB>BK git
|
|
250
|
-
--help >:070BL A?@02:C
|
|
251
|
-
```
|
|
252
|
-
|
|
253
|
-
## =� @8<5@K 2K2>40
|
|
254
|
-
|
|
255
|
-
### 1KG=K9 @5;87
|
|
256
|
-
|
|
257
|
-
```
|
|
258
|
-
Release created successfully!
|
|
259
|
-
|
|
260
|
-
=� Package: my-app
|
|
261
|
-
=� Version: 1.0.0 � 1.1.0
|
|
262
|
-
<� Tag: v1.1.0
|
|
263
|
-
< Release: https://gitverse.ru/owner/repo/releases/tag/v1.1.0
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
### Dry-run @568<
|
|
237
|
+
## CLI Options
|
|
267
238
|
|
|
268
239
|
```
|
|
269
|
-
=
|
|
270
240
|
DRY RUN MODE - No changes will be made
|
|
271
|
-
|
|
272
|
-
=� Package: my-app
|
|
273
|
-
=� Version: 1.0.0 � 1.1.0
|
|
274
|
-
<� Tag: v1.1.0
|
|
275
|
-
=� Commits: 3
|
|
276
|
-
|
|
277
|
-
=� CHANGELOG:
|
|
278
|
-
|
|
279
|
-
## [1.1.0] - 2025-01-31
|
|
280
|
-
|
|
281
|
-
### ( Features
|
|
282
|
-
|
|
283
|
-
- add user authentication ([abc123](https://gitverse.ru/owner/repo/commit/abc123)) by @user
|
|
284
|
-
- implement dark mode ([def456](https://gitverse.ru/owner/repo/commit/def456)) by @user
|
|
285
|
-
|
|
286
|
-
### = Bug Fixes
|
|
287
|
-
|
|
288
|
-
- fix validation error ([ghi789](https://gitverse.ru/owner/repo/commit/ghi789)) by @user
|
|
289
|
-
```
|
|
290
|
-
|
|
291
|
-
## >� "5AB8@>20=85
|
|
292
|
-
|
|
293
|
-
0:5B 8<55B 180+ B5AB>2 A ?>:@KB85< ~99.85%:
|
|
241
|
+
npx @gitverse/release [package] [options]
|
|
294
242
|
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
bun test
|
|
243
|
+
Arguments:
|
|
244
|
+
package Package name for release (for monorepos)
|
|
298
245
|
|
|
299
|
-
|
|
300
|
-
|
|
246
|
+
Options:
|
|
247
|
+
--dry-run Run without making changes
|
|
248
|
+
--version <version> Specify exact version
|
|
249
|
+
--skip-git-check Skip git status check
|
|
250
|
+
--help Show help
|
|
301
251
|
```
|
|
302
252
|
|
|
303
|
-
##
|
|
253
|
+
## CI/CD Integration
|
|
304
254
|
|
|
305
|
-
###
|
|
255
|
+
### GitVerse Actions
|
|
306
256
|
|
|
307
257
|
```yaml
|
|
308
258
|
name: Release
|
|
@@ -308,6 +258,9 @@ name: Release
|
|
|
308
258
|
on:
|
|
309
259
|
workflow_dispatch:
|
|
310
260
|
|
|
261
|
+
env:
|
|
262
|
+
GITVERSE_TOKEN: ${{ secrets.GITVERSE_TOKEN }}
|
|
263
|
+
|
|
311
264
|
jobs:
|
|
312
265
|
release:
|
|
313
266
|
runs-on: ubuntu-latest
|
|
@@ -315,38 +268,34 @@ jobs:
|
|
|
315
268
|
- uses: actions/checkout@v4
|
|
316
269
|
with:
|
|
317
270
|
fetch-depth: 0
|
|
318
|
-
token: ${{ secrets.GH_TOKEN }}
|
|
319
271
|
|
|
320
|
-
- uses: oven-sh/setup-bun@
|
|
272
|
+
- uses: oven-sh/setup-bun@v2
|
|
321
273
|
|
|
322
274
|
- run: bun install
|
|
323
275
|
|
|
324
276
|
- name: Configure Git
|
|
325
277
|
run: |
|
|
326
|
-
git config user.name "
|
|
327
|
-
git config user.email "
|
|
278
|
+
git config user.name "GitVerse CI"
|
|
279
|
+
git config user.email "ci@gitverse.ru"
|
|
328
280
|
|
|
329
281
|
- name: Create Release
|
|
330
282
|
run: bun run release
|
|
331
|
-
env:
|
|
332
|
-
GITVERSE_TOKEN: ${{ secrets.GITVERSE_TOKEN }}
|
|
333
283
|
```
|
|
334
284
|
|
|
335
|
-
##
|
|
285
|
+
## License
|
|
336
286
|
|
|
337
|
-
MIT
|
|
287
|
+
MIT © RainyPixel
|
|
338
288
|
|
|
339
|
-
##
|
|
289
|
+
## Links
|
|
340
290
|
|
|
341
291
|
- [GitVerse SDK](https://gitverse.ru/RainyPixel/gitverse-sdk)
|
|
342
|
-
- [Conventional Commits](https://www.conventionalcommits.org/
|
|
343
|
-
- [Keep a Changelog](https://keepachangelog.com/
|
|
344
|
-
- [Semantic Versioning](https://semver.org/lang/ru/)
|
|
292
|
+
- [Conventional Commits](https://www.conventionalcommits.org/)
|
|
293
|
+
- [Keep a Changelog](https://keepachangelog.com/)
|
|
345
294
|
|
|
346
|
-
##
|
|
295
|
+
## Found a bug?
|
|
347
296
|
|
|
348
|
-
|
|
297
|
+
Create an issue on [GitVerse](https://gitverse.ru/RainyPixel/gitverse-sdk/issues)
|
|
349
298
|
|
|
350
299
|
---
|
|
351
300
|
|
|
352
|
-
|
|
301
|
+
Made with ❤️ for GitVerse
|
package/package.json
CHANGED