Skip to content

Commit cc7c19c

Browse files
pawfapawfa
authored
chore: added Changelog (#74)
1 parent 1234214 commit cc7c19c

6 files changed

Lines changed: 426 additions & 2 deletions

File tree

‎.auto-changelog‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"output": "CHANGELOG.md",
3+
"template": "keepachangelog",
4+
"unreleased": false,
5+
"commitLimit": false,
6+
"hideCredit": true,
7+
"ignoreCommitPattern": "^chore\\(release\\)"
8+
}

‎.yarnrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
version-git-tag false

‎CHANGELOG.md‎

Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [2.6.0](https://github.com/PiwikPRO/react-piwik-pro/compare/2.5.0...2.6.0) - 2026-05-05
9+
10+
### Merged
11+
12+
- [PPI-1511] add new methods for download classes [`#67`](https://github.com/PiwikPRO/react-piwik-pro/pull/67)
13+
- Nonce support for material in example [`#59`](https://github.com/PiwikPRO/react-piwik-pro/pull/59)
14+
- Project guidelines update [`#57`](https://github.com/PiwikPRO/react-piwik-pro/pull/57)
15+
- Check documentation in on-push workflow [`#56`](https://github.com/PiwikPRO/react-piwik-pro/pull/56)
16+
17+
### Commits
18+
19+
- regenerate docs [`bfa4b24`](https://github.com/PiwikPRO/react-piwik-pro/commit/bfa4b240e95d35222b9ecf49d0383da958f4d790)
20+
- bump tracking-base and this package's version [`ee2d0c1`](https://github.com/PiwikPRO/react-piwik-pro/commit/ee2d0c138a561da2856a36a290ff6a185486f5ad)
21+
22+
## [2.5.0](https://github.com/PiwikPRO/react-piwik-pro/compare/2.4.0...2.5.0) - 2025-03-25
23+
24+
### Merged
25+
26+
- Bump tracking-base-library version [`#55`](https://github.com/PiwikPRO/react-piwik-pro/pull/55)
27+
- Changed on-push workflow to build an example app [`#54`](https://github.com/PiwikPRO/react-piwik-pro/pull/54)
28+
29+
## [2.4.0](https://github.com/PiwikPRO/react-piwik-pro/compare/2.3.0...2.4.0) - 2025-02-26
30+
31+
### Merged
32+
33+
- update tracking base lib, update examples [`#53`](https://github.com/PiwikPRO/react-piwik-pro/pull/53)
34+
35+
## [2.3.0](https://github.com/PiwikPRO/react-piwik-pro/compare/2.2.1...2.3.0) - 2025-02-26
36+
37+
### Merged
38+
39+
- Set provider upon initialization [`#52`](https://github.com/PiwikPRO/react-piwik-pro/pull/52)
40+
41+
## [2.2.1](https://github.com/PiwikPRO/react-piwik-pro/compare/2.2.0...2.2.1) - 2025-01-13
42+
43+
### Merged
44+
45+
- Bump version [`#51`](https://github.com/PiwikPRO/react-piwik-pro/pull/51)
46+
- Generate new README.md [`#50`](https://github.com/PiwikPRO/react-piwik-pro/pull/50)
47+
48+
## [2.2.0](https://github.com/PiwikPRO/react-piwik-pro/compare/2.1.3...2.2.0) - 2025-01-10
49+
50+
### Merged
51+
52+
- PPI-1357 Update tracking-base-library, bump package version [`#48`](https://github.com/PiwikPRO/react-piwik-pro/pull/48)
53+
54+
## [2.1.3](https://github.com/PiwikPRO/react-piwik-pro/compare/2.1.2...2.1.3) - 2024-12-13
55+
56+
### Merged
57+
58+
- PPI-1318 Dependency bump version tracker base library [`#46`](https://github.com/PiwikPRO/react-piwik-pro/pull/46)
59+
60+
## [2.1.2](https://github.com/PiwikPRO/react-piwik-pro/compare/2.1.1...2.1.2) - 2024-11-19
61+
62+
### Merged
63+
64+
- Update tracking base library. update vulnerable packages [`#43`](https://github.com/PiwikPRO/react-piwik-pro/pull/43)
65+
66+
### Commits
67+
68+
- update tracking base library. update vulnerable packages [`c2b4410`](https://github.com/PiwikPRO/react-piwik-pro/commit/c2b4410b0a18285e03821ec543b6eeb145995958)
69+
- update lock file [`2505cd8`](https://github.com/PiwikPRO/react-piwik-pro/commit/2505cd87c475a99aae5aa53f664ad9d8f7e645b4)
70+
71+
## [2.1.1](https://github.com/PiwikPRO/react-piwik-pro/compare/2.1.0...2.1.1) - 2024-07-09
72+
73+
### Merged
74+
75+
- Release 2.2.2 - package version bump [`#40`](https://github.com/PiwikPRO/react-piwik-pro/pull/40)
76+
- Use vite as package bundler [`#39`](https://github.com/PiwikPRO/react-piwik-pro/pull/39)
77+
78+
### Commits
79+
80+
- use vite as package bundler [`9267800`](https://github.com/PiwikPRO/react-piwik-pro/commit/92678004a52c20d3dad0233e672fc73f6b77ba21)
81+
- fix: typedoc, simplify react version [`ebd6b1b`](https://github.com/PiwikPRO/react-piwik-pro/commit/ebd6b1bcdd94ecb83642dc52646951393b42181e)
82+
- fix: do not bundle external deps [`dd0bf96`](https://github.com/PiwikPRO/react-piwik-pro/commit/dd0bf96dbafe15ce94f2ce41e9b74255965fed9c)
83+
- package version bump [`0b6ce66`](https://github.com/PiwikPRO/react-piwik-pro/commit/0b6ce660b8540027a9644daa480ca0a25abddad9)
84+
85+
## [2.1.0](https://github.com/PiwikPRO/react-piwik-pro/compare/2.0.1...2.1.0) - 2024-06-10
86+
87+
### Merged
88+
89+
- release 2.1.0 [`#36`](https://github.com/PiwikPRO/react-piwik-pro/pull/36)
90+
91+
## [2.0.1](https://github.com/PiwikPRO/react-piwik-pro/compare/2.0.0...2.0.1) - 2024-04-24
92+
93+
### Merged
94+
95+
- 2.0.1 Bump tracking-base-library [`#35`](https://github.com/PiwikPRO/react-piwik-pro/pull/35)
96+
97+
### Commits
98+
99+
- chore: bump tracking-base-library to 1.1.2 [`90f6201`](https://github.com/PiwikPRO/react-piwik-pro/commit/90f6201f79623aed004b4029947a1c291c64f50d)
100+
101+
## [2.0.0](https://github.com/PiwikPRO/react-piwik-pro/compare/1.3.3...2.0.0) - 2024-04-19
102+
103+
### Merged
104+
105+
- Release 2.0.0 [`#33`](https://github.com/PiwikPRO/react-piwik-pro/pull/33)
106+
- PPI-1059 Add base package [`#32`](https://github.com/PiwikPRO/react-piwik-pro/pull/32)
107+
- fix: enable eslint and follow it's errors [`#28`](https://github.com/PiwikPRO/react-piwik-pro/pull/28)
108+
- fix: ecommerce customDimensions [`#27`](https://github.com/PiwikPRO/react-piwik-pro/pull/27)
109+
- fix(example): use Link component from react router instead of default one [`#26`](https://github.com/PiwikPRO/react-piwik-pro/pull/26)
110+
111+
### Commits
112+
113+
- feat: add base package [`bc8f575`](https://github.com/PiwikPRO/react-piwik-pro/commit/bc8f575a38f7cf4b2515b7e64a94e8436f3ac12f)
114+
- fix: build, update trackEvent docs, update lockfiles [`21d04ef`](https://github.com/PiwikPRO/react-piwik-pro/commit/21d04ef443c3d32aab3a2f51c79724dd05494b37)
115+
- format: run prettier [`6731773`](https://github.com/PiwikPRO/react-piwik-pro/commit/67317738b91a5ca84a5e787ae9570352575b1120)
116+
- fix: use Link component from react router instead of default one [`bfcac91`](https://github.com/PiwikPRO/react-piwik-pro/commit/bfcac9158ccf86effd118c3bb1688f1bc0c8358f)
117+
118+
## [1.3.3](https://github.com/PiwikPRO/react-piwik-pro/compare/1.3.2...1.3.3) - 2024-01-25
119+
120+
### Merged
121+
122+
- Feature/backward compatibilty ecommerce methods [`#25`](https://github.com/PiwikPRO/react-piwik-pro/pull/25)
123+
124+
### Commits
125+
126+
- update readme, package json version [`5fee4cf`](https://github.com/PiwikPRO/react-piwik-pro/commit/5fee4cf40cddf5853702c3e258394f2abc35ee53)
127+
- adds support for deprecated addEcommerceItem method [`e09e1c7`](https://github.com/PiwikPRO/react-piwik-pro/commit/e09e1c731dac21553a7658a5fc9c4c06661542e4)
128+
- adds support for deprecated trackEcommerceOrder method [`746a794`](https://github.com/PiwikPRO/react-piwik-pro/commit/746a7947fe72123f369299e8ef77a4a4042d1f8d)
129+
- removes getEcommerceItems method from example [`26cd448`](https://github.com/PiwikPRO/react-piwik-pro/commit/26cd44849698dedbaee9c136f8c9502b28873860)
130+
- adds support for deprecated setEcommerceView method [`858dd46`](https://github.com/PiwikPRO/react-piwik-pro/commit/858dd460485ba3a50b1353bf0168caa12422bae8)
131+
- adds support for deprecated trackEcommerceCartUpdate method [`620c22e`](https://github.com/PiwikPRO/react-piwik-pro/commit/620c22e971a86c19f2347dee6fe89f88154f97d9)
132+
- adds support for deprecated removeEcommerceItem method [`a0bc27c`](https://github.com/PiwikPRO/react-piwik-pro/commit/a0bc27c3155ab865ae801028062c7a59a385c342)
133+
- update displayed methods in ecommerce page [`a3adfc0`](https://github.com/PiwikPRO/react-piwik-pro/commit/a3adfc0f8edf2cb95954d8af4953f949e089acf2)
134+
- adds support for deprecated clearEcommerceCart method [`424ee13`](https://github.com/PiwikPRO/react-piwik-pro/commit/424ee13e1f072854de4b6bdd78de6b338743b359)
135+
- adds doc for deprecated clearEcommerceCart method [`8ea5230`](https://github.com/PiwikPRO/react-piwik-pro/commit/8ea5230b7c4e9f382d59e580bda45a33b2ef2fdd)
136+
- doc update, deprecated getEcommerceItems method [`833b8b5`](https://github.com/PiwikPRO/react-piwik-pro/commit/833b8b528f703fb145f35e2e7886f2d722d6d4f9)
137+
- doc for deprecated trackEcommerceOrder method [`12d9376`](https://github.com/PiwikPRO/react-piwik-pro/commit/12d937649dc2236695ca397248e77805049e3294)
138+
- deprecated addEcommerce doc update, points to new method [`0439034`](https://github.com/PiwikPRO/react-piwik-pro/commit/0439034f4e0a6706487e9c3749ee174f1337acab)
139+
140+
## [1.3.2](https://github.com/PiwikPRO/react-piwik-pro/compare/1.3.1...1.3.2) - 2024-01-15
141+
142+
### Merged
143+
144+
- Feature/ppi 982 peer dependency update [`#22`](https://github.com/PiwikPRO/react-piwik-pro/pull/22)
145+
146+
### Commits
147+
148+
- supports react from 16.8 to 18 [`a8636d7`](https://github.com/PiwikPRO/react-piwik-pro/commit/a8636d76b776e3345247d05832c90324be91d6f4)
149+
- package version update [`654d9f9`](https://github.com/PiwikPRO/react-piwik-pro/commit/654d9f90537fec67ca5e552361c1469e7c2359b0)
150+
151+
## [1.3.1](https://github.com/PiwikPRO/react-piwik-pro/compare/1.2.1...1.3.1) - 2024-01-09
152+
153+
### Merged
154+
155+
- Feature/ppi 976 new ecommerce methods [`#16`](https://github.com/PiwikPRO/react-piwik-pro/pull/16)
156+
- Feature/ppi 690 update tag manager snippet [`#17`](https://github.com/PiwikPRO/react-piwik-pro/pull/17)
157+
158+
### Commits
159+
160+
- [PPI-976] examples use new package versions and vite [`83522e5`](https://github.com/PiwikPRO/react-piwik-pro/commit/83522e5bfbe56fbabf3546f7429d3d13d37faee7)
161+
- [PPI-976] packages update [`112c9b5`](https://github.com/PiwikPRO/react-piwik-pro/commit/112c9b541af570c60194b6920da444fb711dc39c)
162+
- pr fixes [`c89448f`](https://github.com/PiwikPRO/react-piwik-pro/commit/c89448f81c58f128daf6cc6b013a06fb52e1006b)
163+
- [PPI-976] npm packages update [`9751d5a`](https://github.com/PiwikPRO/react-piwik-pro/commit/9751d5a62a1705d360315c25f5ba27a19f659ebb)
164+
- [PPI-976] remove products type as array [`3ff91cf`](https://github.com/PiwikPRO/react-piwik-pro/commit/3ff91cf876bd94489b51effe1a1b0c03713d9dd4)
165+
- example pages name suffix, getEcommerceItems method use example, types [`d642c8a`](https://github.com/PiwikPRO/react-piwik-pro/commit/d642c8a813befba19fbb65f68399ca2304d832ff)
166+
- [PPI-976] new add ecommerce item method [`ea7388b`](https://github.com/PiwikPRO/react-piwik-pro/commit/ea7388b07dc7f5619cf87643d3904e499d8efff8)
167+
- [PPI-976] update cart, track order [`97bb1ca`](https://github.com/PiwikPRO/react-piwik-pro/commit/97bb1ca15da9b7f5e024247e30fab4cccdd5be02)
168+
- [PPI-690] tag manager snippet updated [`38444cc`](https://github.com/PiwikPRO/react-piwik-pro/commit/38444cca2a836e6b0fa8129a6d78c4241ff2f8c2)
169+
- [PPI-976] ecommerce product detail view [`adbc58b`](https://github.com/PiwikPRO/react-piwik-pro/commit/adbc58b8c352c75464e9195d14fe5475231b036a)
170+
- [PPI-976] remove product from cart [`27e9a0f`](https://github.com/PiwikPRO/react-piwik-pro/commit/27e9a0f7b021e9640133efd53b299e8514579db7)
171+
- [PPI-976] remove/add product from cart refactor [`cd2a0a0`](https://github.com/PiwikPRO/react-piwik-pro/commit/cd2a0a005a9a54cbdc822959c279e3df516b45ac)
172+
- documentation update [`054e42b`](https://github.com/PiwikPRO/react-piwik-pro/commit/054e42b875f15ff469f6a5eab2f8b2dd94e15e4d)
173+
- [PPI-976] add/remove item accepts list of products [`bcd4ff0`](https://github.com/PiwikPRO/react-piwik-pro/commit/bcd4ff0c4cc8437cfc56ca5c09660208e6872420)
174+
- ignore ide jetbrains files [`a03fe40`](https://github.com/PiwikPRO/react-piwik-pro/commit/a03fe403cca3428ee8afdeb2ee14c356d3490860)
175+
- tsconfig bugfix [`5a7504a`](https://github.com/PiwikPRO/react-piwik-pro/commit/5a7504a078961255b23d4b6f563197a77a2e6b31)
176+
- [PPI-976] bugfix in product type. accepts 1-5 product categories [`8016e65`](https://github.com/PiwikPRO/react-piwik-pro/commit/8016e65b01eb59830f4798eb435e78119e3434ea)
177+
- [PPI-976] ecommerceAddToCart constant update [`a7d57c2`](https://github.com/PiwikPRO/react-piwik-pro/commit/a7d57c2e12054f1a55f89b623aa1761e32b9509a)
178+
- ignore jetbrains files [`ebf7324`](https://github.com/PiwikPRO/react-piwik-pro/commit/ebf732444c4c2e2b7515759d0f621d4713b69f11)
179+
- nvm script bug removed from gitignore [`3c593f4`](https://github.com/PiwikPRO/react-piwik-pro/commit/3c593f478a86e911f64226a9588a634e1de54077)
180+
181+
## [1.2.1](https://github.com/PiwikPRO/react-piwik-pro/compare/1.1.2...1.2.1) - 2023-09-25
182+
183+
### Merged
184+
185+
- [PPPSYS-43233] Packages update [`#15`](https://github.com/PiwikPRO/react-piwik-pro/pull/15)
186+
187+
### Commits
188+
189+
- [PPPSYS-43233] added babel plugin - react scripts related [`0731df0`](https://github.com/PiwikPRO/react-piwik-pro/commit/0731df01d87926ab823cf4ec066a4f799c9aae82)
190+
191+
## [1.1.2](https://github.com/PiwikPRO/react-piwik-pro/compare/1.1.1...1.1.2) - 2023-08-29
192+
193+
### Merged
194+
195+
- [PPPSYS-42941] Fix IS_DEBUG variable #12 [`#14`](https://github.com/PiwikPRO/react-piwik-pro/pull/14)
196+
197+
## [1.1.1](https://github.com/PiwikPRO/react-piwik-pro/compare/1.1.0...1.1.1) - 2022-07-16
198+
199+
### Merged
200+
201+
- [PPI-254] Tracking campaign information using the SPA integrations [`#8`](https://github.com/PiwikPRO/react-piwik-pro/pull/8)
202+
203+
## [1.1.0](https://github.com/PiwikPRO/react-piwik-pro/compare/1.0.1...1.1.0) - 2022-06-24
204+
205+
### Merged
206+
207+
- [PPI-220] Introduce support for CSP [`#7`](https://github.com/PiwikPRO/react-piwik-pro/pull/7)
208+
- Support npm 8, react 17 and react 18 [`#6`](https://github.com/PiwikPRO/react-piwik-pro/pull/6)
209+
210+
## [1.0.1](https://github.com/PiwikPRO/react-piwik-pro/compare/1.0.0...1.0.1) - 2022-06-07
211+
212+
### Commits
213+
214+
- Update main.yml [`94d074f`](https://github.com/PiwikPRO/react-piwik-pro/commit/94d074f8dfa6c20e170d19e257fafc527e3de74f)
215+
216+
## [1.0.0](https://github.com/PiwikPRO/react-piwik-pro/compare/0.0.2...1.0.0) - 2022-06-07
217+
218+
### Merged
219+
220+
- Adds DataLayer Methods [`#5`](https://github.com/PiwikPRO/react-piwik-pro/pull/5)
221+
- 3 console logging [`#4`](https://github.com/PiwikPRO/react-piwik-pro/pull/4)
222+
- fix package name [`#2`](https://github.com/PiwikPRO/react-piwik-pro/pull/2)
223+
224+
### Fixed
225+
226+
- Add IS_DEBUG flag resolve #3 [`#3`](https://github.com/PiwikPRO/react-piwik-pro/issues/3)
227+
228+
### Commits
229+
230+
- [PPI-142] Add CONTRIBUTING.md [`3865387`](https://github.com/PiwikPRO/react-piwik-pro/commit/386538758a5d1099da280930003725461dc94134)
231+
- [PPI-113] Add workflow files [`5ee776b`](https://github.com/PiwikPRO/react-piwik-pro/commit/5ee776b08e8657fe00efd58de29ccbaf12893775)
232+
- Update main.yml [`9cbb7f7`](https://github.com/PiwikPRO/react-piwik-pro/commit/9cbb7f71470553459deedfab7f6687d9b68da079)
233+
- [PPI-142] Add LICENSE [`54bff8a`](https://github.com/PiwikPRO/react-piwik-pro/commit/54bff8afbddc2ebc9cffcc4a3204ba72214a1bc5)
234+
- [PPI-142] Add CONTRIBUTING.md [`ad6f1f8`](https://github.com/PiwikPRO/react-piwik-pro/commit/ad6f1f8b62042c445746f1c1639ff5f48d887734)
235+
- [PPI-141] Standardisation of the proper name [`0ea5959`](https://github.com/PiwikPRO/react-piwik-pro/commit/0ea5959cec212ce3e330f6dae432e2effd3a5209)
236+
- [PPI-113] fix author [`a133d65`](https://github.com/PiwikPRO/react-piwik-pro/commit/a133d65f9575b2c5ee26c644c4a258752c839970)
237+
- [PPI-142] Add SECURITY.md [`5131c47`](https://github.com/PiwikPRO/react-piwik-pro/commit/5131c47c01fee736f69e1b327b3123e16646a057)
238+
- Remove unnecessary console.log [`58e0d09`](https://github.com/PiwikPRO/react-piwik-pro/commit/58e0d09092691c4aee0aa3dacb6903d864a20be3)
239+
240+
## [0.0.2](https://github.com/PiwikPRO/react-piwik-pro/compare/0.0.1...0.0.2) - 2022-03-24
241+
242+
### Commits
243+
244+
- Update main.yml [`33f88ad`](https://github.com/PiwikPRO/react-piwik-pro/commit/33f88ad8c16defb0eea63d82baab60cfde488231)
245+
246+
## 0.0.1 - 2022-03-24
247+
248+
### Commits
249+
250+
- init create-react-library@3.1.1 [`4b5a2d0`](https://github.com/PiwikPRO/react-piwik-pro/commit/4b5a2d0adefd9cd8f4cc6f53d8ea69c222e5e5c3)
251+
- Init App [`61f1a3c`](https://github.com/PiwikPRO/react-piwik-pro/commit/61f1a3c20d810fd6a5fb555a76167c983a1cc139)
252+
- Create main.yml [`7c7b478`](https://github.com/PiwikPRO/react-piwik-pro/commit/7c7b478a8c49141761c2c590ef80a759379b397f)

‎RELEASING.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Releasing
2+
3+
Maintainer guide for publishing a new version of `@piwikpro/react-piwik-pro` to npm.
4+
5+
## Prerequisites
6+
7+
- You have merge rights to `master` and your working tree is clean.
8+
- CI on `master` is green.
9+
- Publishing to npm is automated: it runs from `.github/workflows/main.yml`
10+
when a **GitHub Release** is published, using the `NPM_TOKEN` secret. You do
11+
not run `npm publish` by hand.
12+
13+
## Versioning
14+
15+
We follow [Semantic Versioning](https://semver.org):
16+
17+
- **patch** (`x.y.Z`) — bug fixes, dependency bumps, no public API change.
18+
- **minor** (`x.Y.0`) — new backwards-compatible functionality.
19+
- **major** (`X.0.0`) — breaking changes.
20+
21+
## The changelog
22+
23+
`CHANGELOG.md` follows the [Keep a Changelog](https://keepachangelog.com)
24+
convention and is generated from git history by
25+
[auto-changelog](https://github.com/cookpete/auto-changelog) — each entry comes
26+
from a merged pull request, so the quality of the changelog depends on clear PR
27+
titles.
28+
29+
The changelog lists **released versions only** — there is no persistent
30+
"Unreleased" section, since it would go stale between releases. The entry for a
31+
new version is produced automatically as part of the release (see below), by the
32+
`version` npm lifecycle hook — you never generate the changelog by hand. To
33+
preview what will be in the next release at any time, use the GitHub compare
34+
view (`<last-tag>...HEAD`), or run `npx auto-changelog --unreleased --stdout`
35+
(read-only, prints to the terminal without touching the file).
36+
37+
## Release steps
38+
39+
Releases go through a pull request, like everything else — do **not** push the
40+
version bump or a tag directly to `master`. The tag is created by the GitHub
41+
Release **after** the PR is merged, so it points at the real merge commit on
42+
`master`.
43+
44+
1. Start a release branch from an up-to-date `master`:
45+
46+
```sh
47+
git checkout master && git pull
48+
git checkout -b release/x.y.z
49+
```
50+
51+
2. Bump the version. This does **not** create a commit or tag — `.yarnrc` sets
52+
`version-git-tag false`, so `yarn version` only edits `package.json`. The
53+
`version` lifecycle hook still runs, so it also regenerates the changelog
54+
(adds the new version heading + commits since the last release). The version
55+
string itself ends up in the build because `src/index.ts` imports it from
56+
`package.json`, so there is no separate bake step:
57+
58+
```sh
59+
yarn version --patch # or --minor / --major
60+
```
61+
62+
3. Commit and push the branch:
63+
64+
```sh
65+
git commit -am "chore(release): x.y.z"
66+
git push -u origin release/x.y.z
67+
```
68+
69+
4. Open a pull request titled **`chore(release): x.y.z`** and merge it into
70+
`master`. This is what lands the changelog and version bump on `master`.
71+
72+
5. On GitHub, create a **Release** with a **new tag** `x.y.z` targeting `master`.
73+
GitHub creates the tag on the merged commit. Use the matching `CHANGELOG.md`
74+
section as the release notes.
75+
76+
6. Publishing the GitHub Release triggers `main.yml`, which builds and publishes
77+
to npm. Verify at
78+
<https://www.npmjs.com/package/@piwikpro/react-piwik-pro>.
79+
80+
## Notes
81+
82+
- When you create the GitHub Release, type the tag **unprefixed** (`2.6.1`, not
83+
`v2.6.1`). This matches the existing tag history and the changelog compare
84+
links, which auto-changelog derives from the (unprefixed) `package.json`
85+
version. The tag is created by the GitHub Release, so this is a manual
86+
convention — nothing enforces it automatically.
87+
- If a release fails to publish, fix the issue and re-publish the GitHub
88+
Release (or re-run the `main.yml` workflow); you do not need a new version
89+
for a failed publish.

‎package.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
},
2222
"scripts": {
2323
"dev": "vite build --watch",
24+
"version": "auto-changelog -p && git add CHANGELOG.md",
2425
"build": "tsc && vite build",
2526
"build:docs": "typedoc && concat-md --decrease-title-levels --start-title-level-at=2 docs_raw > README.md && node scripts/postProcessDocs.js",
2627
"preview": "vite preview",
@@ -47,6 +48,7 @@
4748
"@types/react-dom": "^18.2.18",
4849
"@eslint/js": "^9.39.1",
4950
"typescript-eslint": "^8.46.2",
51+
"auto-changelog": "^2.6.0",
5052
"concat-md": "^0.5.1",
5153
"cross-env": "^7.0.3",
5254
"eslint": "^9.39.1",

0 commit comments

Comments
 (0)