githublogen 0.3.5 → 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 +1 -1
- package/package.json +2 -2
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
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "githublogen",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.3.
|
|
4
|
+
"version": "0.3.6",
|
|
5
5
|
"packageManager": "pnpm@8.12.0",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "Soybean",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"execa": "8.0.1",
|
|
44
44
|
"kolorist": "1.8.0",
|
|
45
45
|
"ofetch": "1.3.3",
|
|
46
|
-
"@soybeanjs/changelog": "0.3.
|
|
46
|
+
"@soybeanjs/changelog": "0.3.6"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@soybeanjs/cli": "0.8.8",
|