ayaports/backports/signal-desktop/README.md

62 lines
2.6 KiB
Markdown
Raw Normal View History

# signal-desktop
This is the `signal-desktop` package for Alpine Linux.
Please report any issues [using Gitlab](https://gitlab.alpinelinux.org/alpine/aports/-/issues/new) and tag @ayakael
## Building signal-desktop
Signal-desktop is an electron application that is rather complex to build
The first layer of complexity is the use of dependencies that are themselves
rather complex to build. Some are based on nodejs, others rust. Those
dependencies are built before signal-desktop, like ringrtc, webrtc and
libsignal. The versions of those dependencies are tracked in different files,
which adds complexity when maintaining the package. Executing `abuild
_update_depends` automatically fetches the expected versions and updates
the relevant variables.
A second layer of complexity is that webrtc's source code isn't available as a
downloadable tarball. It is only fetchable using Google's `gclient` available
in `depot_tools` with a reimplemented version in the `teapot` package. By
executing, `abuild snapshot`, webrtc tarball can be fetched and packaged, as
long as `gclient` is in your path. For ease of maintenance, a workflow on
[Ayakael's Forge](https://ayakael.net/mirrors/signal-desktop) automatically
fetches and packages the source code and makes it available in a [generic
Forgejo repository](https://ayakael.net/mirrors/-/packages/generic/webrtc).
## Updating signal-desktop
In a nutshell:
1. Set `pkgver` to up-to-date version
2. Update the dependency versions using `abuild _update_depends`
3. Optional: fetch webrtc using `abuild snapshot`, making sure `client`
is in your path
4. Update source checksum using `abuild checksum`
## Finding dependency version information
Here is where the version information is stored. It is different for every
extra dependency.
* _libsignalver: follow signal-desktop package.json ->
@signalapp/libsignal-client
* _ringrtcver: follow signal-desktop package.json -> @signalapp/ringrtc
* _webrtcver: follow ringrtc (on version above) -> config/version.properties ->
webrtc.version downloading tarball generated with abuild snapshot (with gclient
dependencies fetched)
* _stokenizerver: follow @signalapp/better-sqlite3 (on version in package.json)
-> deps/download.js -> TOKENIZER_VERSION
## Why is this package still in testing
As `electron` is still in testing, this package cannot yet be moved to
`community`. Until that changes, this package is also kept-to-date against the
latest release of Alpine Linux (along with `electron`) in
[Ayakael's Forge](https://ayakael.net/forge/-/packages/alpine/signal-desktop).
This is true of all Ayakael's packages still in `testing`.