Skip to content

Commit 24bf8aa

Browse files
authored
Merge pull request #80 from ViktorTigerstrom/2023-07-update-release-notes
doc: update release notes
2 parents 8bc4706 + 611ebc8 commit 24bf8aa

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

RELEASE.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ This document describes the steps needed to release a new version of LNC binarie
77
1. Android Studio with Android SDK (API level 16 or newer)
88
2. Xcode (latest version)
99
3. Go v1.21.0 or newer
10+
4. gomobile (https://pkg.go.dev/golang.org/x/mobile/cmd/gomobile)
11+
5. javac version 1.7 or higher (Included in Java Development Kit 7+)
12+
13+
#### Android Studio SDK tools requirements
14+
15+
Ensure that NDK is installed for the Android Studio SDK tools.
16+
To install NDK in Android Studio, navigate to Preferences (or Settings) |
17+
Appearance & Behavior | System Settings | Android SDK. Navigate to the SDK Tools
18+
tab, mark `NDK (Side by side)` and then click the "Apply" button.
1019

1120
### Build Release Binaries
1221

@@ -26,6 +35,14 @@ When this completes, a `build` dir will be created with four files:
2635

2736
### Sign the manifest and rename the signature file
2837

38+
For the signing commands below to work without modifying the path, you first
39+
need navigate `build` dir that was created with the `make release` command
40+
above.
41+
42+
```sh
43+
$ cd build
44+
```
45+
2946
#### Sign the manifest file using your PGP key.
3047

3148
- Replace `{PGP_EMAIL}` with your email address associated with your PGP key
@@ -35,8 +52,18 @@ When this completes, a `build` dir will be created with four files:
3552
$ gpg --default-key {PGP_EMAIL} --output manifest-{GITHUB_USERNAME}-vX.Y.Z-alpha.sig --detach-sign manifest-vX.Y.Z-alpha.txt
3653
```
3754

55+
#### Create an Open Timestamp for the signed manifest
56+
57+
Go to https://opentimestamps.org. Upload the newly generated
58+
`manifest-{GITHUB_USERNAME}-vX.Y.Z-alpha.sig` signature file, and download the
59+
resulting `ots` file.
60+
3861
### Create a tag and push to Github
3962

63+
First, double check that the release you just created, was based on the latest
64+
upstream master branch commit. Also verify that you are currently based on the
65+
on the latest master branch commit when creating any tags!
66+
4067
Using the `-s` option signs the tag with your PGP key
4168

4269
```sh
@@ -52,13 +79,14 @@ On Github create a new release. Select the tag you just pushed, then click the
5279
Take the rest of the content from a previous release. Be sure to update the
5380
version number and update the verification examples to use your own PGP key.
5481

55-
In the assets, include these five files:
82+
In the assets, include these six files:
5683

5784
- lnc-vX.Y.Z-alpha.wasm
5885
- lnc-vX.Y.Z-alpha-android.zip
5986
- lnc-vX.Y.Z-alpha-ios.zip
6087
- manifest-vX.Y.Z-alpha.txt
6188
- manifest-{GITHUB_USERNAME}-vX.Y.Z-alpha.sig
89+
- manifest-{GITHUB_USERNAME}-vX.Y.Z-alpha.sig.ots
6290

6391
### Deploy the WASM binary to CDN
6492

0 commit comments

Comments
 (0)