Skip to content

Commit

Permalink
Merge PR #912 from 'nodech/update-docs'
Browse files Browse the repository at this point in the history
  • Loading branch information
nodech committed Dec 27, 2024
2 parents 9b70c29 + 7f8ecc5 commit 5c9eceb
Show file tree
Hide file tree
Showing 6 changed files with 300 additions and 74 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## v7.0.0

**When upgrading to this version of hsd, you must pass `--wallet-migrate=4` when
**When upgrading to this version of hsd, you must pass `--wallet-migrate=5` when
you run it for the first time.**

### Primitives
Expand Down
1 change: 0 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ HSD
## Links
- [Install](./install.md)
- [Configuration](https://hsd-dev.org/guides/config.html)
- [Release schedule](./release-schedule.md)
- [Release process](./release-process.md)
- [Release files](./release-files.md)

Expand Down
36 changes: 3 additions & 33 deletions docs/release-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Releasing hsd and hs-client
This document contains information about bundling, signing and
distributing the files.

`hsd/hs-client` is distributed through several platforms: `github`, `npm`, `brew`.
`hsd/hs-client` is distributed through several platforms: `github`, `npm`.

<!-- markdown-toc -i release-files.md -->

Expand All @@ -17,8 +17,6 @@ distributing the files.
- [Minor, Patch](#minor-patch)
* [Deploying to npm](#deploying-to-npm)
+ [Deploying latest version, minor and patches included](#deploying-latest-version-minor-and-patches-included)
+ [Deploying support versions (previous and life-support)](#deploying-support-versions-previous-and-life-support)
* [Deploying to homebrew](#deploying-to-homebrew)
* [Deploying to handshake.org](#deploying-to-handshakeorg)
+ [Building tarball](#building-tarball)
+ [Signing and upload](#signing-and-upload)
Expand Down Expand Up @@ -46,8 +44,6 @@ After you are [ready](./release-process.md) to publish files (for example
- `git tag --force -s latest` - Tag `v4.0.0` as `latest`.
- `git checkout v3.x.x` - latest `v3` version.
- `git tag --force -s previous` - Tag latest `v3` as `previous`.
- `git checkout v2.x.x` - latest `v2` version.
- `git tag --force -s life-support` - Tag latest `v2` as `life-support`.

#### Minor, Patch
If we are updating minor/patch versions, regardless of the `major`, we
Expand All @@ -61,8 +57,8 @@ it will update `previous` tag. We will have full example with `major`:

## Deploying to npm
Maintainer needs access rights to the npm repository. Releasing
on npm by default tags the release with `latest`, so releasing latest
and supporting older versions is different.
on npm by default tags the release with `latest`.
`previous` tag is not released on npm.

NOTE: You can use `npm publish --dry-run` to see the details before actual
release.
Expand All @@ -74,27 +70,6 @@ Major, minor and patch of the latest version deployment (for example v4.1.0):

NOTE: `package.json` should have been updated in `v4.1.0` tag to `4.1.0`.

### Deploying support versions (previous and life-support)
Older versions can have additional tags for `previous` and `life-support`:
- `git checkout v3.1.0` - switch to the tag for the `previous` version.
- `npm publish --tag previous` - update appropriate npm tag for the release.
or
- `git checkout v2.4.1` - switch to the tag for the `life-support` version.
- `npm publish --tag life-support` - update appropriate npm tag for the
release.

NOTE: `package.json` should have been updated in `v3.1.0` tag to `3.1.0`.

## Deploying to homebrew
To deploy to the popular MacOS package manager [brew][homebrew], you will
need to create Pull request to the [Hombrew Core repository][homebrew-repo].
Formula for the `hsd` can be found at `homebrew-core/Formula/hsd.rb`
- Update `homebrew-core/Formula/hsd.rb`. (e.g. [hsd 3.0.1][homebrew-update])
- You can check the steps when formula was introduced
[hsd formula][homebrew-new-formula] or review the
[Guidelines][homebrew-guidelines].
- Additionally double check if `nodejs` version needs update.

## Deploying to handshake.org
Handshake.org website is hosted via github and can be found at
[handshake-org/handshake-web][handshake-web]. Website contains easy to install
Expand Down Expand Up @@ -149,11 +124,6 @@ publish by itself, only generate files to review locally.
release.


[homebrew]: https://brew.sh/
[homebrew-repo]: https://github.com/Homebrew/homebrew-core
[homebrew-new-formula]: https://github.com/Homebrew/homebrew-core/pull/51014
[homebrew-update]: https://github.com/Homebrew/homebrew-core/pull/87779/files
[homebrew-guidelines]: https://github.com/Homebrew/homebrew-core/blob/master/CONTRIBUTING.md
[handshake-web]: https://github.com/handshake-org/handshake-web/
[bpkg]: https://github.com/chjj/bpkg
[hsclient]: https://github.com/handshake-org/hs-client
Loading

0 comments on commit 5c9eceb

Please sign in to comment.