Compare commits

...

1 Commits

Author SHA1 Message Date
ledhed2222
c05ab08fff merge develop into master (#1806)
* add HISTORY for monorepo updates and update CONTRIBUTING.md for publication

* fix GitHub pages (#1802)

* Publish

 - ripple-address-codec@4.2.0
 - ripple-binary-codec@1.2.0
 - ripple-keypairs@1.1.0
 - xrpl@2.0.2

* moves back git hub pages docs to the top
2021-11-17 18:44:42 -05:00
160 changed files with 37 additions and 9 deletions

View File

@@ -128,16 +128,25 @@ npm uninstall abbrev -w xrpl
1. Ensure that all tests passed on the last CI that ran on `develop`. 1. Ensure that all tests passed on the last CI that ran on `develop`.
2. Open a PR to update the docs if docs were modified. 2. Open a PR to update the docs if docs were modified.
3. Create a branch off `develop` that ensures that `HISTORY.md` is updated appropriately for each package. 3. Create a branch off `develop` that ensures that `HISTORY.md` is updated appropriately for each package.
* Use `shasum -a 256 build/*` to get the SHA-256 checksums. Add these to `HISTORY.md` as well.
4. Merge this branch into `develop`. 4. Merge this branch into `develop`.
5. If this is not a beta release: Merge `develop` into `master` (`--ff-only`) and push to github. This is important because we have docs telling developers to use master to get the latest release. 5. If this is not a beta release: Merge `develop` into `master` (`--ff-only`) and push to github. This is important because we have docs telling developers to use master to get the latest release.
6. Create a new Github release/tag off of this branch. ___
7. Run `npm publish --dry-run` and make sure everything looks good. NOW WE ARE READY TO PUBLISH! No new code changes happen manually now.
8. Publish the release to `npm`. ___
* If this is a beta release, run `npm publish --tag beta`. This allows someone else to install this version of the package with `npm install xrpl@beta`. 6. Checkout `master` and `git pull`.
* If this is a stable release, run `npm publish`. 7. Run `npm run build` to triple check the build still works
* This will require entering `npm` login info. 8. Run `npx lerna publish`. This command will diff all packages. Any changed
9. Send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce). package will be staged for publication.
9. For each changed package, pick what the new version should be. Lerna will bump the versions, commit version bumps to `master`, and create a new git tag for each published package.
10. Enter your [npmjs.com](https://npmjs.com) OTP (one-time password) to complete publication.
___
NOW YOU HAVE PUBLISHED! But you're not done; we have to notify people!
___
11. On github, click the "releases" link on the right-hand side of the page.
12. In the top-left corner, click the "tags" toggle.
13. For each new tag created by lerna, click the context button (the one that looks like "...") and select "new release" to create a new release from this tag.
14. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
15. Send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce).
## Mailing Lists ## Mailing Lists
We have a low-traffic mailing list for announcements of new `xrpl.js` releases. (About 1 email every couple of weeks) We have a low-traffic mailing list for announcements of new `xrpl.js` releases. (About 1 email every couple of weeks)

View File

Before

Width:  |  Height:  |  Size: 9.4 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

View File

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

View File

Before

Width:  |  Height:  |  Size: 480 B

After

Width:  |  Height:  |  Size: 480 B

View File

Before

Width:  |  Height:  |  Size: 855 B

After

Width:  |  Height:  |  Size: 855 B

Some files were not shown because too many files have changed in this diff Show More