Skip to content

Commit 0c189bc

Browse files
author
codewec
committed
chore: add changelog
1 parent 4557d3a commit 0c189bc

4 files changed

Lines changed: 106 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Changelog
2+
3+
4+
## 1.0.0...main
5+
6+
[compare changes](https://github.com/codewec/paneo/compare/1.0.0...main)
7+
8+
### 🩹 Fixes
9+
10+
- Insecure auth ([4557d3a](https://github.com/codewec/paneo/commit/4557d3a))
11+
12+
### ❤️ Contributors
13+
14+
- Codewec
15+
16+
## 1.0.0...main
17+
18+
[compare changes](https://github.com/codewec/paneo/compare/1.0.0...main)
19+
20+
### 🩹 Fixes
21+
22+
- Insecure auth ([4557d3a](https://github.com/codewec/paneo/commit/4557d3a))
23+
24+
### ❤️ Contributors
25+
26+
- Codewec <codeforwec@gmail.com>
27+

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,43 @@ pnpm lint
263263
pnpm build
264264
```
265265

266+
### Releases (changelogen)
267+
268+
Generate/update `CHANGELOG.md`:
269+
270+
```bash
271+
pnpm changelog
272+
```
273+
274+
Preview changelog changes without writing:
275+
276+
```bash
277+
pnpm changelog:dry
278+
```
279+
280+
`dry` alias (same as `changelog:dry`):
281+
282+
```bash
283+
pnpm dry
284+
```
285+
286+
Create a release with version bump, changelog update, commit and tag:
287+
288+
```bash
289+
pnpm release
290+
```
291+
292+
Current scripts use `--hideAuthorEmail`, so author emails are not included in release notes.
293+
If you also want to hide the contributors block completely, use `--noAuthors`.
294+
295+
Recommended release flow:
296+
297+
1. Ensure branch is up to date and checks pass.
298+
2. Preview notes: `pnpm dry`.
299+
3. Create release commit + tag: `pnpm release`.
300+
4. Push commit and tag: `git push --follow-tags`.
301+
5. GitHub Actions (`docker-publish`) publishes release images from the pushed tag.
302+
266303
### Project Structure
267304

268305
- `app/pages/index.vue` - file manager workspace page

package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
{
22
"name": "paneo",
3+
"version": "1.0.0",
34
"private": true,
45
"type": "module",
56
"scripts": {
67
"build": "nuxt build",
8+
"changelog": "changelogen --hideAuthorEmail --output CHANGELOG.md",
9+
"changelog:dry": "changelogen --dry --hideAuthorEmail --output CHANGELOG.md",
710
"dev": "nuxt dev",
11+
"dry": "pnpm changelog:dry",
812
"preview": "nuxt preview",
913
"postinstall": "nuxt prepare",
1014
"lint": "eslint .",
15+
"release": "changelogen --release --hideAuthorEmail --output CHANGELOG.md",
1116
"typecheck": "nuxt typecheck"
1217
},
1318
"dependencies": {
@@ -20,6 +25,7 @@
2025
"devDependencies": {
2126
"@nuxt/eslint": "^1.13.0",
2227
"@types/node": "^25.2.1",
28+
"changelogen": "^0.6.2",
2329
"eslint": "^9.39.2",
2430
"typescript": "^5.9.3",
2531
"vue-tsc": "^3.2.4"

pnpm-lock.yaml

Lines changed: 36 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)