Skip to content

Commit 7f8ecc5

Browse files
committed
docs: backport release notes for v7. Simplify release process.
1 parent 9b70c29 commit 7f8ecc5

File tree

6 files changed

+300
-74
lines changed

6 files changed

+300
-74
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## v7.0.0
44

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

88
### Primitives

docs/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ HSD
44
## Links
55
- [Install](./install.md)
66
- [Configuration](https://hsd-dev.org/guides/config.html)
7-
- [Release schedule](./release-schedule.md)
87
- [Release process](./release-process.md)
98
- [Release files](./release-files.md)
109

docs/release-files.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Releasing hsd and hs-client
44
This document contains information about bundling, signing and
55
distributing the files.
66

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

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

@@ -17,8 +17,6 @@ distributing the files.
1717
- [Minor, Patch](#minor-patch)
1818
* [Deploying to npm](#deploying-to-npm)
1919
+ [Deploying latest version, minor and patches included](#deploying-latest-version-minor-and-patches-included)
20-
+ [Deploying support versions (previous and life-support)](#deploying-support-versions-previous-and-life-support)
21-
* [Deploying to homebrew](#deploying-to-homebrew)
2220
* [Deploying to handshake.org](#deploying-to-handshakeorg)
2321
+ [Building tarball](#building-tarball)
2422
+ [Signing and upload](#signing-and-upload)
@@ -46,8 +44,6 @@ After you are [ready](./release-process.md) to publish files (for example
4644
- `git tag --force -s latest` - Tag `v4.0.0` as `latest`.
4745
- `git checkout v3.x.x` - latest `v3` version.
4846
- `git tag --force -s previous` - Tag latest `v3` as `previous`.
49-
- `git checkout v2.x.x` - latest `v2` version.
50-
- `git tag --force -s life-support` - Tag latest `v2` as `life-support`.
5147

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

6258
## Deploying to npm
6359
Maintainer needs access rights to the npm repository. Releasing
64-
on npm by default tags the release with `latest`, so releasing latest
65-
and supporting older versions is different.
60+
on npm by default tags the release with `latest`.
61+
`previous` tag is not released on npm.
6662

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

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

77-
### Deploying support versions (previous and life-support)
78-
Older versions can have additional tags for `previous` and `life-support`:
79-
- `git checkout v3.1.0` - switch to the tag for the `previous` version.
80-
- `npm publish --tag previous` - update appropriate npm tag for the release.
81-
or
82-
- `git checkout v2.4.1` - switch to the tag for the `life-support` version.
83-
- `npm publish --tag life-support` - update appropriate npm tag for the
84-
release.
85-
86-
NOTE: `package.json` should have been updated in `v3.1.0` tag to `3.1.0`.
87-
88-
## Deploying to homebrew
89-
To deploy to the popular MacOS package manager [brew][homebrew], you will
90-
need to create Pull request to the [Hombrew Core repository][homebrew-repo].
91-
Formula for the `hsd` can be found at `homebrew-core/Formula/hsd.rb`
92-
- Update `homebrew-core/Formula/hsd.rb`. (e.g. [hsd 3.0.1][homebrew-update])
93-
- You can check the steps when formula was introduced
94-
[hsd formula][homebrew-new-formula] or review the
95-
[Guidelines][homebrew-guidelines].
96-
- Additionally double check if `nodejs` version needs update.
97-
9873
## Deploying to handshake.org
9974
Handshake.org website is hosted via github and can be found at
10075
[handshake-org/handshake-web][handshake-web]. Website contains easy to install
@@ -149,11 +124,6 @@ publish by itself, only generate files to review locally.
149124
release.
150125

151126

152-
[homebrew]: https://brew.sh/
153-
[homebrew-repo]: https://github.com/Homebrew/homebrew-core
154-
[homebrew-new-formula]: https://github.com/Homebrew/homebrew-core/pull/51014
155-
[homebrew-update]: https://github.com/Homebrew/homebrew-core/pull/87779/files
156-
[homebrew-guidelines]: https://github.com/Homebrew/homebrew-core/blob/master/CONTRIBUTING.md
157127
[handshake-web]: https://github.com/handshake-org/handshake-web/
158128
[bpkg]: https://github.com/chjj/bpkg
159129
[hsclient]: https://github.com/handshake-org/hs-client

0 commit comments

Comments
 (0)