Skip to content

Commit c6fc416

Browse files
committed
docs(projects): add README.md
1 parent e4a2f12 commit c6fc416

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

packages/githublogen/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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+
```

0 commit comments

Comments
 (0)