@agglayer/sdk 0.1.0-beta.3 → 1.0.0-beta.10
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/README.md +31 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -33,11 +33,12 @@ const sdk = new AggLayerSDK();
|
|
|
33
33
|
|
|
34
34
|
## 📋 Release Channels
|
|
35
35
|
|
|
36
|
-
| Channel | Description
|
|
37
|
-
| -------- |
|
|
38
|
-
| `latest` | Stable releases
|
|
39
|
-
| `beta` |
|
|
40
|
-
| `alpha` |
|
|
36
|
+
| Channel | Description | Stability | Usage |
|
|
37
|
+
| -------- | -------------------------------- | ------------------- | --------------------------------- |
|
|
38
|
+
| `latest` | Stable releases (v1.0.0, v2.0.0) | ✅ Production Ready | `npm install @agglayer/sdk` |
|
|
39
|
+
| `beta` | Beta releases (v1.0.0-beta.1) | ⚠️ Testing | `npm install @agglayer/sdk@beta` |
|
|
40
|
+
| `alpha` | Alpha releases (v1.0.0-alpha.1) | 🚧 Experimental | `npm install @agglayer/sdk@alpha` |
|
|
41
|
+
| `dev` | Development releases | 🔧 Development | `npm install @agglayer/sdk@dev` |
|
|
41
42
|
|
|
42
43
|
## 🏗️ Architecture
|
|
43
44
|
|
|
@@ -211,6 +212,31 @@ const nativeOnlySdk = new AggLayerSDK({
|
|
|
211
212
|
});
|
|
212
213
|
```
|
|
213
214
|
|
|
215
|
+
## 🚀 Release Process
|
|
216
|
+
|
|
217
|
+
The SDK uses a tag-based release workflow for all releases:
|
|
218
|
+
|
|
219
|
+
### **Tag-Based Releases**
|
|
220
|
+
|
|
221
|
+
```bash
|
|
222
|
+
# Create and push a tag to trigger release
|
|
223
|
+
git tag v1.0.0-beta.1
|
|
224
|
+
git push origin v1.0.0-beta.1
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### **Manual Releases**
|
|
228
|
+
|
|
229
|
+
1. Go to GitHub Actions → "Tag Release"
|
|
230
|
+
2. Choose release type and channel
|
|
231
|
+
3. Click "Run workflow"
|
|
232
|
+
|
|
233
|
+
### **Release Types**
|
|
234
|
+
|
|
235
|
+
- **Stable**: `v1.0.0` → `latest` channel
|
|
236
|
+
- **Beta**: `v1.0.0-beta.1` → `beta` channel
|
|
237
|
+
- **Alpha**: `v1.0.0-alpha.1` → `alpha` channel
|
|
238
|
+
- **Dev**: `v1.0.0-dev.1` → `dev` channel
|
|
239
|
+
|
|
214
240
|
## 🔧 Development
|
|
215
241
|
|
|
216
242
|
### Prerequisites
|