diff --git a/.release-please-manifest.json b/.release-please-manifest.json index e59c522..8a08c58 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,4 @@ { - ".": "0.0.3-alpha" -} \ No newline at end of file + ".": "0.1.0-alpha.0", + "dapp": "0.1.0-alpha.0" +} \ No newline at end of file diff --git a/RELEASE_PLEASE_VERSIONING.md b/RELEASE_PLEASE_VERSIONING.md new file mode 100644 index 0000000..6e08c6f --- /dev/null +++ b/RELEASE_PLEASE_VERSIONING.md @@ -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! diff --git a/dapp/package-lock.json b/dapp/package-lock.json index 8c1196a..9a85db7 100644 --- a/dapp/package-lock.json +++ b/dapp/package-lock.json @@ -1,12 +1,12 @@ { "name": "dapp", - "version": "0.0.2-alpha", + "version": "0.1.0-alpha.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "dapp", - "version": "0.0.2-alpha", + "version": "0.1.0-alpha.0", "license": "ISC", "dependencies": { "@iexec/dataprotector-deserializer": "^0.1.1", diff --git a/dapp/package.json b/dapp/package.json index 9b9cb2e..eb1b47b 100644 --- a/dapp/package.json +++ b/dapp/package.json @@ -1,7 +1,6 @@ { "name": "dapp", - "version": "0.0.2-alpha", - "description": "", + "version": "0.1.0-alpha.0", "main": "index.js", "type": "module", "engines": { diff --git a/package-lock.json b/package-lock.json index dd9f268..446d9b2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@iexec/web3telegram", - "version": "0.0.3-alpha", + "version": "0.1.0-alpha.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@iexec/web3telegram", - "version": "0.0.3-alpha", + "version": "0.1.0-alpha.0", "license": "Apache-2.0", "dependencies": { "@ethersproject/bytes": "^5.7.0", diff --git a/package.json b/package.json index bc57f7c..0288e47 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/release-please-config.json b/release-please-config.json index d95d382..ded43de 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -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" } } -} \ No newline at end of file +} \ No newline at end of file