githublogen 0.3.4 → 0.3.6
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 +51 -0
- package/dist/cli.mjs +2 -1
- package/package.json +19 -11
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# githublogen
|
|
2
|
+
|
|
3
|
+
Generate changelog for GitHub releases from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), powered by [changelogithub](https://github.com/antfu/changelogithub).
|
|
4
|
+
|
|
5
|
+
Auto Generate CHANGELOG.md from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), powered by [changelogen](https://github.com/unjs/changelogen).
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
In GitHub Actions:
|
|
10
|
+
|
|
11
|
+
```yml
|
|
12
|
+
# .github/workflows/release.yml
|
|
13
|
+
|
|
14
|
+
name: Release
|
|
15
|
+
|
|
16
|
+
permissions:
|
|
17
|
+
contents: write
|
|
18
|
+
|
|
19
|
+
on:
|
|
20
|
+
push:
|
|
21
|
+
tags:
|
|
22
|
+
- "v*"
|
|
23
|
+
|
|
24
|
+
jobs:
|
|
25
|
+
release:
|
|
26
|
+
runs-on: ubuntu-latest
|
|
27
|
+
steps:
|
|
28
|
+
- uses: actions/checkout@v3
|
|
29
|
+
with:
|
|
30
|
+
fetch-depth: 0
|
|
31
|
+
|
|
32
|
+
- uses: actions/setup-node@v3
|
|
33
|
+
with:
|
|
34
|
+
node-version: 16.x
|
|
35
|
+
|
|
36
|
+
- run: npx githublogen
|
|
37
|
+
env:
|
|
38
|
+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
It will be trigged whenever you push a tag to GitHub that starts with `v`.
|
|
42
|
+
|
|
43
|
+
## Configuration
|
|
44
|
+
|
|
45
|
+
You can put a configuration file in the project root, named as `githublogen.config.{json,ts,js,mjs,cjs}`, `.githublogenrc` or use the `githublogen` field in `package.json`.
|
|
46
|
+
|
|
47
|
+
## Preview Locally
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npx githublogen --dry
|
|
51
|
+
```
|
package/dist/cli.mjs
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
+
import process from 'node:process';
|
|
2
3
|
import cac from 'cac';
|
|
3
4
|
import { cyan, green, red, yellow, dim, blue, bold } from 'kolorist';
|
|
4
5
|
import { getChangelogMarkdown } from '@soybeanjs/changelog';
|
|
@@ -481,7 +482,7 @@ function createConsola(options = {}) {
|
|
|
481
482
|
}
|
|
482
483
|
const consola = createConsola();
|
|
483
484
|
|
|
484
|
-
const version = "0.3.
|
|
485
|
+
const version = "0.3.6";
|
|
485
486
|
|
|
486
487
|
function getHeaders(githubToken) {
|
|
487
488
|
return {
|
package/package.json
CHANGED
|
@@ -1,16 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "githublogen",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.3.
|
|
5
|
-
"
|
|
4
|
+
"version": "0.3.6",
|
|
5
|
+
"packageManager": "pnpm@8.12.0",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "Soybean",
|
|
8
8
|
"email": "soybeanjs@outlook.com",
|
|
9
9
|
"url": "https://github.com/soybeanjs"
|
|
10
10
|
},
|
|
11
11
|
"license": "MIT",
|
|
12
|
-
"
|
|
13
|
-
|
|
12
|
+
"homepage": "https://github.com/soybeanjs/changelog/tree/main/packages/githublogen",
|
|
13
|
+
"repository": {
|
|
14
|
+
"url": "https://github.com/soybeanjs/changelog.git"
|
|
15
|
+
},
|
|
16
|
+
"bugs": {
|
|
17
|
+
"url": "https://github.com/soybeanjs/changelog/issues"
|
|
14
18
|
},
|
|
15
19
|
"keywords": [
|
|
16
20
|
"github",
|
|
@@ -20,6 +24,10 @@
|
|
|
20
24
|
"changelog",
|
|
21
25
|
"log"
|
|
22
26
|
],
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"registry": "https://registry.npmjs.org/"
|
|
29
|
+
},
|
|
30
|
+
"sideEffects": false,
|
|
23
31
|
"bin": {
|
|
24
32
|
"githublogen": "./dist/cli.mjs"
|
|
25
33
|
},
|
|
@@ -30,21 +38,21 @@
|
|
|
30
38
|
"node": ">=12.0.0"
|
|
31
39
|
},
|
|
32
40
|
"dependencies": {
|
|
33
|
-
"c12": "1.
|
|
41
|
+
"c12": "1.5.1",
|
|
34
42
|
"cac": "6.7.14",
|
|
35
43
|
"execa": "8.0.1",
|
|
36
44
|
"kolorist": "1.8.0",
|
|
37
|
-
"ofetch": "1.
|
|
38
|
-
"@soybeanjs/changelog": "0.3.
|
|
45
|
+
"ofetch": "1.3.3",
|
|
46
|
+
"@soybeanjs/changelog": "0.3.6"
|
|
39
47
|
},
|
|
40
48
|
"devDependencies": {
|
|
41
|
-
"@soybeanjs/cli": "0.
|
|
42
|
-
"@types/node": "20.
|
|
43
|
-
"typescript": "5.
|
|
49
|
+
"@soybeanjs/cli": "0.8.8",
|
|
50
|
+
"@types/node": "20.10.4",
|
|
51
|
+
"typescript": "5.3.3",
|
|
44
52
|
"unbuild": "2.0.0"
|
|
45
53
|
},
|
|
46
54
|
"scripts": {
|
|
47
|
-
"build": "
|
|
55
|
+
"build": "unbuild",
|
|
48
56
|
"stub": "pnpm unbuild --stub",
|
|
49
57
|
"typecheck": "tsc --noEmit --skipLibCheck"
|
|
50
58
|
}
|