diff options
author | Kali Kaneko (leap communications) <kali@leap.se> | 2018-10-09 20:48:06 +0200 |
---|---|---|
committer | Kali Kaneko (leap communications) <kali@leap.se> | 2018-10-09 21:06:19 +0200 |
commit | aacd91dac38dc6be764f95ee881b6c60eb1a21ee (patch) | |
tree | a94b7c2c0a0cd7592f0f9cdcc9a813818ea5065f /snap | |
parent | 4bdb7dcd5ecc062f37ce6aaa82091067d77c7e8b (diff) |
[docs] improve readme
Adds some installation and build instructions.
- Resolves: #35
Diffstat (limited to 'snap')
-rw-r--r-- | snap/release.rst (renamed from snap/README.rst) | 37 |
1 files changed, 6 insertions, 31 deletions
diff --git a/snap/README.rst b/snap/release.rst index 5e01908..5211aea 100644 --- a/snap/README.rst +++ b/snap/release.rst @@ -1,30 +1,14 @@ -RiseupVPN ---------- - -This is the Snap package for RiseupVPN. RiseupVPN is a specialized build of -bitmask, that lacks client authentication and is preconfigured to use a single -provider (riseup.net). - -This snap is built using bitmask-systray with the -standalone flag. - -Building ---------- - -First of all, make sure that the version in the snapcraft.yaml file matches what we're building. -We're following the convention of adding +git to any build that comes after a tag. +Automatic builds (snap) +~~~~~~~~~~~~~~~~~~~~~~~ +Gitlab builds snap for amd64 for every push to master in bitmask-systray. Launchpad does up 4 daily builds if code is modified in bitmask-dev repo. We're -building for amd64, i386 and arm8. +building for amd64 and i386. They are pushed to beta channel in the snap store. If you need to force a build, trigger it by editing the version string in the snapcraft.yaml file. -For local builds, you can use 'make snap_in_docker'. This builds in a docker -container (provided by snapcraft/snapcore). At this moment, this image is based -in xenial - therefore, a special tag is needed for the gtk3 libs in go. - - -Releasing ---------- +Releasing snaps +---------------- From the snap dashboard, you can see the revisions that are built. By default, we have riseupvpn-builds configured to upload builds to beta and @@ -73,12 +57,3 @@ From the command line: snapcraft release riseupv-vpn 19 beta snapcraft release riseupv-vpn 19 edge - -Testing -------- - -To install a snap published on a specific channel, indicate the channel from the commandline: - - snap install riseup-vpn --classic --edge - snap install riseup-vpn --classic --beta - snap install riseup-vpn --classic --candidate |