You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASE.md
+20-16Lines changed: 20 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,21 +10,23 @@ You can manually trigger the release workflow from the [GitHub Actions UI](https
10
10
11
11
### **Before triggering a release**
12
12
13
-
1. Create a release branch. A qualified branch name should start with "release-" or "release/", case-insensitive. e.g: `release/xrpl@4.3.8`, `release-xrpl-4.3.8`, `Release/xrpl@4.3.8`.
14
-
2. Update the **`version`** field in `packages/<package_name>/package.json` to the intended release version.
15
-
```json
16
-
{
17
-
"name": "<package_name>",
18
-
"version": "x.y.z"
19
-
}
20
-
```
21
-
3. Run npm i to update the package-lock with the updated versions and commit the lock file to the release branch
13
+
**Stable release (`npmjs_dist_tag = latest`)**
14
+
1. Branch: must start with `release-` or `release/` (case-insensitive), e.g., `release/xrpl@4.3.8` or `release-xrpl-4.3.8`.
15
+
2. Version: `packages/<package_name>/package.json` must use strict SemVer `x.y.z`.
16
+
3. Tag: leave `npmjs_dist_tag` blank or set to `latest`.
17
+
4. Lockfile: run `npm i` to refresh `package-lock.json` and commit it.
18
+
19
+
**Beta/experimental release (any other `npmjs_dist_tag`)**
20
+
1. Branch: no `release-`/`release/` naming requirement.
21
+
2. Version: `packages/<package_name>/package.json` can be prerelease/other valid SemVer.
22
+
3. Tag: choose a non-`latest``npmjs_dist_tag` matching `[a-z][a-z0-9._-]{0,127}` and not starting with `v` + digit or a digit; the workflow publishes it as `<tag>-experimental`.
23
+
4. Lockfile: run `npm i` to refresh `package-lock.json` and commit it.
22
24
23
25
### **Triggering a Release**
24
26
25
-
1. Go to **GitHub → Actions → Release Pipeline → Run workflow**
26
-
2.Choose the release branch from dropdown
27
-
3. Fill in these fields:
27
+
1. Go to **GitHub → Actions → Release Pipeline → Run workflow** (must be triggered from `main`).
28
+
2.Fill in these fields:
29
+
-**release_branch_name** → Name of the release branch to run against.
28
30
-**package_name** → The folder name under `packages/`, e.g., `xrpl` or `ripple-address-codec`.
29
31
-**npmjs_dist_tag** → The npm distribution tag to publish under. Defaults to `latest`.
30
32
- Examples:
@@ -34,10 +36,11 @@ You can manually trigger the release workflow from the [GitHub Actions UI](https
34
36
35
37
➡️ Example:
36
38
37
-
| Field | Example |
38
-
|------------------|-----------------------|
39
-
| package_name | xrpl |
40
-
| npmjs_dist_tag | latest |
39
+
| Field | Example |
40
+
|---------------------|-----------------------|
41
+
| release_branch_name | release/xrpl@4.3.8 |
42
+
| package_name | xrpl |
43
+
| npmjs_dist_tag | latest |
41
44
42
45
43
46
### **Reviewing the release details and scan result**
@@ -58,6 +61,7 @@ You can manually trigger the release workflow from the [GitHub Actions UI](https
58
61
### 2. **Run Tests**
59
62
- Triggers the `faucet_test.yml` and `nodejs.yml` workflows to run unit, integration, and faucet tests against the specified Git ref.
60
63
- Ensures the code at the given Git ref passes all tests.
0 commit comments