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: CONTRIBUTING.md
+27-26Lines changed: 27 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -236,47 +236,48 @@ Note: The same updated config can be used to update xrpl-py's CI as well.
236
236
## Release
237
237
238
238
1. Checkout `main` (or your beta branch) and `git pull`.
239
-
1. Create a new branch (`git checkout -b <BRANCH_NAME>`) to capture updates that take place during this process.
240
-
1. Update `HISTORY.md` to reflect release changes.
239
+
2. Create a new branch (`git checkout -b <BRANCH_NAME>`) to capture updates that take place during this process.
240
+
3. Update `HISTORY.md` to reflect release changes.
241
241
242
242
-[ ] Update the version number and release date, and ensure it lists the changes since the previous release.
243
243
244
-
1. Run `npm run docgen` if the docs were modified in this release to update them (skip this step for a beta).
245
-
1. Run `npm run build` to triple check the build still works
246
-
1. Run `npx lerna version --no-git-tag-version` - This bumps the package versions.
244
+
4. Run `npm run docgen` if the docs were modified in this release to update them (skip this step for a beta).
245
+
5. Run `npm run clean` to delete previously generated artifacts.
246
+
6. Run `npm run build` to triple check the build still works
247
+
7. Run `npx lerna version --no-git-tag-version` - This bumps the package versions.
247
248
248
249
- For each changed package, pick what the new version should be. Lerna will bump the versions, commit version bumps to `main`, and create a new git tag for each published package.
249
250
- If you do NOT want to update the package number, choose "Custom Version" and set the version to be the same as the existing version. Lerna will not publish any changes in this case.
250
251
- If publishing a beta, make sure that the versions are all of the form `a.b.c-beta.d`, where `a`, `b`, and `c` are identical to the last normal release except for one, which has been incremented by 1.
251
252
252
-
1. Run `npm i` to update the package-lock with the updated versions.
253
-
1. Create a new PR from this branch into `main` and merge it (you can directly merge into the beta branch for a beta).
254
-
1. Checkout `main` and `git pull` (you can skip this step for a beta since you already have the latest version of the beta branch).
255
-
1. Actually publish the packages with one of the following:
253
+
8. Run `npm i` to update the package-lock with the updated versions.
254
+
9. Create a new PR from this branch into `main` and merge it (you can directly merge into the beta branch for a beta).
255
+
10. Checkout `main` and `git pull` (you can skip this step for a beta since you already have the latest version of the beta branch).
256
+
11. Actually publish the packages with one of the following:
256
257
257
-
- Stable release: Run `npx lerna publish from-package --yes`
Notice this allows developers to install the package with `npm add xrpl@beta`
260
261
261
-
1. If requested, enter your [npmjs.com](https://npmjs.com) OTP (one-time password) to complete publication.
262
+
12. If requested, enter your [npmjs.com](https://npmjs.com) OTP (one-time password) to complete publication.
262
263
263
-
NOW YOU HAVE PUBLISHED! But you're not done; we have to notify people!
264
+
NOW YOU HAVE PUBLISHED! But you're not done; we have to notify people!
264
265
265
-
1. Run `git tag <tagname> -m <tagname>`, where `<tagname>` is the new package and version (e.g. `[email protected]`), for each version released.
266
-
1. Run `git push --follow-tags`, to push the tags to Github.
267
-
1. On GitHub, click the "Releases" link on the right-hand side of the page.
266
+
13. Run `git tag <tagname> -m <tagname>`, where `<tagname>` is the new package and version (e.g. `[email protected]`), for each version released.
267
+
14. Run `git push --follow-tags`, to push the tags to Github.
268
+
15. On GitHub, click the "Releases" link on the right-hand side of the page.
268
269
269
-
1. Repeat for each release:
270
+
16. Repeat for each release:
270
271
271
-
1. Click "Draft a new release"
272
-
1. Click "Choose a tag", and choose a tag that you just created.
273
-
1. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
272
+
1. Click "Draft a new release"
273
+
2. Click "Choose a tag", and choose a tag that you just created.
274
+
3. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
274
275
275
-
1. Send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce).
276
-
1. Lastly, send a similar message to the XRPL Discord in the [`javascript` channel](https://discord.com/channels/886050993802985492/886053111179915295). The message should include:
277
-
1. The version changes for xrpl libraries
278
-
1. A link to the more detailed changes
279
-
1. Highlights of important changes
276
+
17. Send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce).
277
+
18. Lastly, send a similar message to the XRPL Discord in the [`javascript` channel](https://discord.com/channels/886050993802985492/886053111179915295). The message should include:
0 commit comments