diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2023-03-15 11:11:51 +0100 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2023-03-15 11:16:18 +0100 |
| commit | 61871cb9ea7605e5350e9612edf8c9d603da2883 (patch) | |
| tree | e355bcdbecffd9023d0e3f0083a6b5061cfc9108 /docs | |
| parent | d03eb2e0032c99170dafd8558c104a0c50ab103f (diff) | |
Docs: Add release building info
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/SUMMARY.md | 1 | ||||
| -rw-r--r-- | docs/src/gettingstarted/building/release.md | 15 |
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 6ec2259..09ba35d 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -7,6 +7,7 @@ - [Python wrapper](./gettingstarted/building/python.md) - [Example from scratch](./gettingstarted/building/example.md) - [Package Formats](./gettingstarted/building/packageformats.md) + - [Building for release](./gettingstarted/building/release.md) - [Testing](./gettingstarted/testing.md) - [Debugging](./gettingstarted/debugging/README.md) - [Logging](./gettingstarted/debugging/logging.md) diff --git a/docs/src/gettingstarted/building/release.md b/docs/src/gettingstarted/building/release.md new file mode 100644 index 0000000..a0893ea --- /dev/null +++ b/docs/src/gettingstarted/building/release.md @@ -0,0 +1,15 @@ +# Building for release + +To build for release, make sure you obtain the tarball artifacts in the release (ending with `.tar.xz`) at <https://github.com/eduvpn/eduvpn-common/releases>. + +These are signed with minisign and gpg keys, make sure to verify these signatures using the public keys available here: <https://github.com/eduvpn/eduvpn-common/tree/main/keys>, they are also available externally: +- <https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc> +- <https://git.sr.ht/~jwijenbergh/python3-eduvpn-common.rpm/tree/main/item/SOURCES/minisign-CA9409316AC93C07.pub> + +To build for release, make sure to extract the tarball, and then add `-tags=release` to the `GOFLAGS` environment variable: + +```bash +GOFLAGS="-tags=release" make +``` + +Proceed the build like normally. |