Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
".": "0.0.3-alpha"
}
".": "0.1.0-alpha.0",
"dapp": "0.1.0-alpha.0"
}
102 changes: 102 additions & 0 deletions RELEASE_PLEASE_VERSIONING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Release-Please Versioning Guide

## Important: When to Remove `versioning: 'prerelease'`

### Current State (Prerelease Versions) - WORKING FINE

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.

**✅ CURRENT CONFIG (Working):**

```json
{
"packages": {
".": {
"release-type": "node",
"prerelease": true,
"prerelease-type": "alpha",
"versioning": "prerelease" // ← This is working fine for prereleases
}
}
}
```

### When to Remove `versioning: 'prerelease'`

The `versioning: 'prerelease'` field should be **REMOVED** when:

1. **Transitioning to stable versions** (like `1.0.0`, `2.1.0`)
2. **Moving away from prerelease mode**
3. **Starting a new stable release cycle**

**❌ INCORRECT for stable versions:**

```json
{
"packages": {
".": {
"release-type": "node",
"versioning": "prerelease" // ← REMOVE THIS for stable versions
}
}
}
```

**✅ CORRECT for stable versions:**

```json
{
"packages": {
".": {
"release-type": "node"
// No versioning field needed for stable versions
}
}
}
```

### Migration Path

#### Step 1: Current (Prerelease) - WORKING

```json
{
"packages": {
".": {
"release-type": "node",
"prerelease": true,
"prerelease-type": "alpha",
"versioning": "prerelease" // ← Keep this for prereleases
}
}
}
```

#### Step 2: When reaching stable version (1.0.0) - REMOVE

```json
{
"packages": {
".": {
"release-type": "node"
// Remove versioning field for stable versions
}
}
}
```

### Current Configuration (Prerelease Versions)

Since your packages are currently at:

- Main package: `0.1.0-alpha.0`
- Dapp package: `0.1.0-alpha.0`

### Summary

| Package Version | Config Field | Action |
| --------------- | -------------------------- | --------------------- |
| `0.1.0-alpha.0` | `versioning: 'prerelease'` | ✅ **KEEP** (working) |
| `1.0.0` | `versioning: 'prerelease'` | ❌ **REMOVE** |

**Remember**: The `versioning` field works fine for prereleases but should be removed when transitioning to stable versions!
4 changes: 2 additions & 2 deletions dapp/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions dapp/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "dapp",
"version": "0.0.2-alpha",
"description": "",
"version": "0.1.0-alpha.0",
"main": "index.js",
"type": "module",
"engines": {
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@iexec/web3telegram",
"version": "0.0.3-alpha",
"version": "0.1.0-alpha.0",
"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.",
"main": "./dist/index.js",
"type": "module",
Expand Down
13 changes: 11 additions & 2 deletions release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,16 @@
"include-v-in-tag": true,
"prerelease": true,
"prerelease-type": "alpha",
"versioning": "prerelease"
"versioning": "prerelease",
"exclude-paths": ["dapp","deployment-dapp","tests"]
},
"dapp": {
"release-type": "node",
"changelog-path": "dapp/CHANGELOG.md",
"include-v-in-tag": true,
"prerelease": true,
"versioning": "prerelease",
"prerelease-type": "alpha"
}
}
}
}
Loading