@furystack/yarn-plugin-changelog 1.0.1 → 1.0.3
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/CHANGELOG.md +21 -0
- package/README.md +112 -6
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.0.3] - 2026-02-11
|
|
4
|
+
|
|
5
|
+
### ⬆️ Dependencies
|
|
6
|
+
|
|
7
|
+
- Bump `vitest` from `^4.0.17` to `^4.0.18`
|
|
8
|
+
- Bump `@types/node` from `^25.0.10` to `^25.2.3`
|
|
9
|
+
|
|
10
|
+
## [1.0.2] - 2026-02-01
|
|
11
|
+
|
|
12
|
+
### 📚 Documentation
|
|
13
|
+
|
|
14
|
+
### Getting Started Guide
|
|
15
|
+
|
|
16
|
+
Added a step-by-step installation and setup guide to the README covering:
|
|
17
|
+
|
|
18
|
+
- Package installation with `yarn add -D @furystack/yarn-plugin-changelog`
|
|
19
|
+
- `.yarnrc.yml` configuration with `changesetBaseRefs` and plugin path
|
|
20
|
+
- `.gitignore` setup to track version manifests and changelog drafts
|
|
21
|
+
- Recommended `package.json` scripts (`bumpVersions`, `applyReleaseChanges`)
|
|
22
|
+
- CI/CD setup examples with GitHub Actions workflows for version bump and changelog validation
|
|
23
|
+
|
|
3
24
|
## [1.0.1] - 2026-01-26
|
|
4
25
|
|
|
5
26
|
### 🔧 Chores
|
package/README.md
CHANGED
|
@@ -2,18 +2,124 @@
|
|
|
2
2
|
|
|
3
3
|
A Yarn plugin for automated changelog generation and management in monorepos. It integrates with Yarn's version plugin to generate, validate, and apply changelog entries from version manifests.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Getting Started
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### Step 1: Install the Plugin
|
|
8
|
+
|
|
9
|
+
Import the plugin directly from the repository:
|
|
8
10
|
|
|
9
11
|
```bash
|
|
10
|
-
yarn plugin import https://raw.githubusercontent.com/furystack/furystack/
|
|
12
|
+
yarn plugin import https://raw.githubusercontent.com/furystack/furystack/refs/heads/develop/packages/yarn-plugin-changelog/bundles/%40yarnpkg/plugin-changelog.js
|
|
11
13
|
```
|
|
12
14
|
|
|
13
|
-
|
|
15
|
+
This will automatically add the plugin to your `.yarnrc.yml` and download it to `.yarn/plugins/`.
|
|
14
16
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
+
### Step 2: Configure Base Refs
|
|
18
|
+
|
|
19
|
+
Add the `changesetBaseRefs` setting to your `.yarnrc.yml` to specify which branches to compare against when checking for version bumps:
|
|
20
|
+
|
|
21
|
+
```yaml
|
|
22
|
+
changesetBaseRefs:
|
|
23
|
+
- develop
|
|
24
|
+
- origin/develop
|
|
25
|
+
- master
|
|
26
|
+
- origin/master
|
|
27
|
+
- main
|
|
28
|
+
- origin/main
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Step 3: Update `.gitignore`
|
|
32
|
+
|
|
33
|
+
Add these lines to your `.gitignore` to track version manifests and changelog drafts:
|
|
34
|
+
|
|
35
|
+
```gitignore
|
|
36
|
+
.yarn/*
|
|
37
|
+
!.yarn/patches
|
|
38
|
+
!.yarn/plugins
|
|
39
|
+
!.yarn/releases
|
|
40
|
+
!.yarn/sdks
|
|
41
|
+
!.yarn/versions
|
|
42
|
+
!.yarn/changelogs
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Step 4: Add Scripts to `package.json`
|
|
46
|
+
|
|
47
|
+
Add these recommended scripts to your root `package.json`:
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"scripts": {
|
|
52
|
+
"bumpVersions": "yarn version check --interactive",
|
|
53
|
+
"applyReleaseChanges": "yarn version apply --all && yarn changelog apply && yarn prettier --write ."
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Step 5: CI/CD Setup (Optional)
|
|
59
|
+
|
|
60
|
+
To enforce changelog entries in your CI pipeline, create these GitHub Actions workflows:
|
|
61
|
+
|
|
62
|
+
**`.github/workflows/check-version-bump.yml`:**
|
|
63
|
+
|
|
64
|
+
```yaml
|
|
65
|
+
name: Version checks
|
|
66
|
+
on:
|
|
67
|
+
push:
|
|
68
|
+
branches-ignore:
|
|
69
|
+
- 'release/**'
|
|
70
|
+
- 'master'
|
|
71
|
+
- 'develop'
|
|
72
|
+
jobs:
|
|
73
|
+
check:
|
|
74
|
+
name: Check version bumps
|
|
75
|
+
timeout-minutes: 5
|
|
76
|
+
runs-on: ubuntu-latest
|
|
77
|
+
steps:
|
|
78
|
+
- name: Checkout
|
|
79
|
+
uses: actions/checkout@v4
|
|
80
|
+
with:
|
|
81
|
+
fetch-depth: 0
|
|
82
|
+
- name: Use Node.js
|
|
83
|
+
uses: actions/setup-node@v4
|
|
84
|
+
with:
|
|
85
|
+
node-version: '24'
|
|
86
|
+
- name: Check version bumps
|
|
87
|
+
run: yarn version check
|
|
88
|
+
env:
|
|
89
|
+
CI: true
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
**`.github/workflows/check-changelog.yml`:**
|
|
93
|
+
|
|
94
|
+
```yaml
|
|
95
|
+
name: Changelog checks
|
|
96
|
+
on:
|
|
97
|
+
push:
|
|
98
|
+
branches-ignore:
|
|
99
|
+
- 'release/**'
|
|
100
|
+
- 'master'
|
|
101
|
+
- 'develop'
|
|
102
|
+
pull_request:
|
|
103
|
+
branches:
|
|
104
|
+
- develop
|
|
105
|
+
jobs:
|
|
106
|
+
check:
|
|
107
|
+
name: Check changelog completion
|
|
108
|
+
timeout-minutes: 5
|
|
109
|
+
runs-on: ubuntu-latest
|
|
110
|
+
steps:
|
|
111
|
+
- name: Checkout
|
|
112
|
+
uses: actions/checkout@v4
|
|
113
|
+
with:
|
|
114
|
+
fetch-depth: 0
|
|
115
|
+
- name: Use Node.js
|
|
116
|
+
uses: actions/setup-node@v4
|
|
117
|
+
with:
|
|
118
|
+
node-version: '24'
|
|
119
|
+
- name: Check changelog entries
|
|
120
|
+
run: yarn changelog check
|
|
121
|
+
env:
|
|
122
|
+
CI: true
|
|
17
123
|
```
|
|
18
124
|
|
|
19
125
|
## Usage
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@furystack/yarn-plugin-changelog",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Yarn plugin for managing changelogs from version manifests",
|
|
5
5
|
"license": "GPL-2.0",
|
|
6
6
|
"main": "./bundles/@yarnpkg/plugin-changelog.js",
|
|
@@ -40,10 +40,10 @@
|
|
|
40
40
|
"clipanion": "^4.0.0-rc.4"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
|
-
"@types/node": "^25.
|
|
43
|
+
"@types/node": "^25.2.3",
|
|
44
44
|
"@yarnpkg/builder": "^4.2.3",
|
|
45
45
|
"typescript": "^5.9.3",
|
|
46
|
-
"vitest": "^4.0.
|
|
46
|
+
"vitest": "^4.0.18"
|
|
47
47
|
},
|
|
48
48
|
"engines": {
|
|
49
49
|
"node": ">=22.0.0"
|