Skip to content

Commit 9a6145f

Browse files
ci: update package versions and add release-please versioning guide
1 parent e2f523c commit 9a6145f

File tree

5 files changed

+109
-5
lines changed

5 files changed

+109
-5
lines changed

RELEASE_PLEASE_VERSIONING.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Release-Please Versioning Guide
2+
3+
## Important: When to Remove `versioning: 'prerelease'`
4+
5+
### Current State (Prerelease Versions) - WORKING FINE
6+
7+
When your packages are using **prerelease versions** (like `0.0.3-alpha.0`, `0.1.0-beta.1`, etc.), the `versioning: 'prerelease'` field **CAN BE USED** and is working correctly.
8+
9+
**✅ CURRENT CONFIG (Working):**
10+
11+
```json
12+
{
13+
"packages": {
14+
".": {
15+
"release-type": "node",
16+
"prerelease": true,
17+
"prerelease-type": "alpha",
18+
"versioning": "prerelease" // ← This is working fine for prereleases
19+
}
20+
}
21+
}
22+
```
23+
24+
### When to Remove `versioning: 'prerelease'`
25+
26+
The `versioning: 'prerelease'` field should be **REMOVED** when:
27+
28+
1. **Transitioning to stable versions** (like `1.0.0`, `2.1.0`)
29+
2. **Moving away from prerelease mode**
30+
3. **Starting a new stable release cycle**
31+
32+
**❌ INCORRECT for stable versions:**
33+
34+
```json
35+
{
36+
"packages": {
37+
".": {
38+
"release-type": "node",
39+
"versioning": "prerelease" // ← REMOVE THIS for stable versions
40+
}
41+
}
42+
}
43+
```
44+
45+
**✅ CORRECT for stable versions:**
46+
47+
```json
48+
{
49+
"packages": {
50+
".": {
51+
"release-type": "node"
52+
// No versioning field needed for stable versions
53+
}
54+
}
55+
}
56+
```
57+
58+
### Migration Path
59+
60+
#### Step 1: Current (Prerelease) - WORKING
61+
62+
```json
63+
{
64+
"packages": {
65+
".": {
66+
"release-type": "node",
67+
"prerelease": true,
68+
"prerelease-type": "alpha",
69+
"versioning": "prerelease" // ← Keep this for prereleases
70+
}
71+
}
72+
}
73+
```
74+
75+
#### Step 2: When reaching stable version (1.0.0) - REMOVE
76+
77+
```json
78+
{
79+
"packages": {
80+
".": {
81+
"release-type": "node"
82+
// Remove versioning field for stable versions
83+
}
84+
}
85+
}
86+
```
87+
88+
### Current Configuration (Prerelease Versions)
89+
90+
Since your packages are currently at:
91+
92+
- Main package: `0.0.3-alpha.0`
93+
- Dapp package: `0.0.2-alpha.0`
94+
95+
**You CAN keep `versioning: 'prerelease'` in your config - it's working fine.**
96+
97+
### Summary
98+
99+
| Package Version | Config Field | Action |
100+
| --------------- | -------------------------- | --------------------- |
101+
| `0.0.3-alpha.0` | `versioning: 'prerelease'` |**KEEP** (working) |
102+
| `1.0.0` | `versioning: 'prerelease'` |**REMOVE** |
103+
104+
**Remember**: The `versioning` field works fine for prereleases but should be removed when transitioning to stable versions!

dapp/package-lock.json

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

dapp/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dapp",
3-
"version": "0.0.2-alpha.0",
3+
"version": "0.0.1-alpha.0",
44
"main": "index.js",
55
"type": "module",
66
"engines": {

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@iexec/web3telegram",
3-
"version": "0.0.3-alpha.0",
3+
"version": "0.1.0-alpha.0",
44
"description": "Enables secure, blockchain-based messaging by encrypting Telegram user IDs for privacy. It lets users message Ethereum account holders without knowing their Telegram details.",
55
"main": "./dist/index.js",
66
"type": "module",

0 commit comments

Comments
 (0)