dexc-desktop: Snap package #2580

peterzen · 2023-10-26T10:17:03Z

This PR adds configuration, build scripts and Github workflow to build the Snap package and publishing it in the Snap Store.

The snap build uses the .deb package. The PR also contains a few fixes/improvements in the deb build:

Icons: added SVG icon for hicolor and symbolic variations, fixed 128px PNG to match official version
icon install location changed to /usr/share/icons which is the XDG standard
binary installs in /usr/bin directly (this is standard practice, simplifies deb scripts)
added AppStream metainfo file (for GNOME/KDE/Ubuntu software centers and the snap)

JoeGruffins

Getting an error when running ./pkg/pkg-debian.sh:

dpkg-deb: error: parsing file './build/dexc_bf46fe348fb83893408e875408499761a3df5ea4-0_amd64/DEBIAN/control' near line 2 package 'dexc':
 'Version' field value 'bf46fe348fb83893408e875408499761a3df5ea4': version number does not start with digit

client/cmd/dexc-desktop/README.md

peterzen · 2023-11-15T12:05:12Z

dpkg-deb: error: parsing file './build/dexc_bf46fe348fb83893408e875408499761a3df5ea4-0_amd64/DEBIAN/control' near line 2 package 'dexc':
'Version' field value 'bf46fe348fb83893408e875408499761a3df5ea4': version number does not start with digit

It pulls the version number from the git tag - the idea being that for release builds there's always a tag but for dev builds the commit hash confuses the deb build. Maybe this needs to be reconsidered.

If you git tag v0.7.0 or similar it will work.

JoeGruffins · 2023-11-16T05:43:58Z

It pulls the version number from the git tag - the idea being that for release builds there's always a tag but for dev builds the commit hash confuses the deb build. Maybe this needs to be reconsidered.

So the commit needs a tag to work? I did not know. Maybe add that to the readme there at least if it is a requirement?

JoeGruffins

After adding a bogus tag was able to build and install with snap.

buck54321

I'm not seeing the benefit of the github actions deployment. What does it do for us over just running the script ourselves?

Icons: added SVG icon for hicolor and symbolic variations, fixed 128px PNG to match official version

Can you say more about the new files and what they do for us? Or point me to some documentation?

I don't care about the official logo version. I changed it because the official color was too dark and looked bad in my panel. None of this matters much, of course, because we're rebranding anyway, but prefer to use the lighter color that has margins.

client/cmd/dexc-desktop/metainfo/org.decred.dcrdex.metainfo.xml

client/cmd/dexc-desktop/pkg/common.sh

peterzen · 2023-11-27T18:20:13Z

I'm not seeing the benefit of the github actions deployment. What does it do for us over just running the script ourselves?

It does the same thing but makes life a tad easier. snapcraft, the snap builder isn't straightforward to run on systems other than Ubuntu as it requires several manual steps to initialize lxd which the build relies on. So basically you need to run the script in an Ubuntu VM which I presumed isn't the system of choice for running release builds.

The binary it packages into a snap comes from the .deb package.

Icons: added SVG icon for hicolor and symbolic variations, fixed 128px PNG to match official version

Can you say more about the new files and what they do for us? Or point me to some documentation?

dexc.png is scaled to 128px which is one of the default icon sizes, the 100px version was scaled up and rendered blurry
dexc.svg is a scalable version which the desktop environment picks up when a bitmap in the required size is not available
dexc-symbolic.svg is a B/W version that the desktop environment might use with certain accessibility settings like monochrome etc. Also this is ideally the icon to be used in the systray as in that size this provides the most contrast.

https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html

I don't care about the official logo version. I changed it because the official color was too dark and looked bad in my panel. None of this matters much, of course, because we're rebranding anyway, but prefer to use the lighter color that has margins.

The tray icon should really match the other icons (menu, dock, task switcher), if it's different it looks odd. How about using the monochrome version? That's the most distinctly recognizable in the tray visually.

buck54321 · 2024-01-17T16:07:02Z

client/cmd/dexc-desktop/pkg/pkg-debian.sh

+if [ ! -d ../../webserver/site/dist ]; then
+  CWD=$(pwd)
+  cd ../../webserver/site
+  npm clean-install
+  npm run build
+  cd $CWD
+fi


Just because there's a file there doesn't mean its the right one. Any reason not to just build it every time?

The idea here was that the site package is added to the repo on the release branch so there's no need to build it at the time of building the release packages but it certainly won't hurt.

buck54321 · 2024-01-17T16:13:41Z

client/cmd/dexc-desktop/pkg/common.sh

+# in this directory.
+
+# pick up the release tag from git
+VER=$(git describe --tags --abbrev=0 --always | sed -e 's/^v//')


Hmm. If I do

git fetch upstream --tags git checkout -b v0.6.3 v0.6.3 git describe --tags --abbrev=0 --always | sed -e 's/^v//'

I get

0.6.2

Does upstream point to github.com/decred/dcrdex? I'm getting the correct tag on a fresh clone.

$ git clone https://github.com/decred/dcrdex Cloning into 'dcrdex'... ... $ cd dcrdex $ git fetch origin --tags $ git checkout -b v0.6.3 v0.6.3 Switched to a new branch 'v0.6.3' $ git describe --tags --abbrev=0 --always | sed -e 's/^v//' 0.6.3

client/cmd/dexc-desktop/pkg/pkg-debian.sh

buck54321 · 2024-01-17T16:30:11Z

client/cmd/dexc-desktop/pkg/publish-snap.sh

+
+snapcraft login
+


This will prompt for snapcraft account credentials? Is it expected that the app is already snapcraft register'd?

Yes, it will ask for the account creds - the app must be registered in the same account.
https://snapcraft.io/snaps

buck54321 · 2024-01-17T16:31:14Z

client/cmd/dexc-desktop/snap/local/snapcraft.yaml.in

+    prime:
+      - -usr/lib/x86_64-linux-gnu/libEGL_mesa*
+      - -usr/lib/x86_64-linux-gnu/libGLX_mesa*
+      - -usr/lib/x86_64-linux-gnu/libGLESv2*
+      - -usr/lib/x86_64-linux-gnu/libcaca++*
+      - -usr/lib/x86_64-linux-gnu/libcolordprivate*
+      - -usr/lib/x86_64-linux-gnu/libdconf*
+      - -usr/lib/x86_64-linux-gnu/libexslt*
+      - -usr/lib/x86_64-linux-gnu/libgstcheck-1.0*
+      - -usr/lib/x86_64-linux-gnu/libgstcontroller-1.0*
+      - -usr/lib/x86_64-linux-gnu/libicuio*
+      - -usr/lib/x86_64-linux-gnu/libicutest*
+      - -usr/lib/x86_64-linux-gnu/libjacknet*
+      - -usr/lib/x86_64-linux-gnu/libjackserver*
+      - -usr/lib/x86_64-linux-gnu/liborc-test-0.4*
+      - -usr/lib/x86_64-linux-gnu/libpulse-simple*
+      - -usr/lib/x86_64-linux-gnu/libunwind-coredump*
+      - -usr/lib/x86_64-linux-gnu/libunwind-ptrace*
+      - -usr/lib/x86_64-linux-gnu/libunwind-x86_64*
+      - -usr/lib/x86_64-linux-gnu/libwoff2enc*
+      - -usr/lib/x86_64-linux-gnu/libicutu*


How is this list generated and what does it mean?

These are libraries that .deb packages in the dexc.deb dependency tree (libgtk-3-0, libwebkit2gtk-4.0-37 and their deps) install but are not required. The list is emitted by snapcraft.

buck54321 · 2024-01-17T16:31:34Z

client/cmd/dexc-desktop/snap/local/snapcraft.yaml.in

+    plugs: 
+      - home
+      - opengl
+      - x11
+      - desktop
+      - desktop-legacy
+      - network
+      - network-status
+      - browser-support
+      - screen-inhibit-control
+      - dbus-svc
+      - dbus-dbusmenu
+      - dbus-statusnotifier


How is this list generated and what does it mean?

This list defines the snap interfaces the app needs access to, basically they translate into AppArmor permissions. It's assembled from the documentation and trial-and-error.

https://snapcraft.io/docs/interface-management

buck54321 · 2024-01-17T16:33:52Z

client/cmd/dexc-desktop/go.mod

@@ -66,7 +66,7 @@ require (
 	github.com/decred/dcrd/dcrec/edwards/v2 v2.0.3 // indirect
 	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0 // indirect
 	github.com/decred/dcrd/dcrjson/v4 v4.0.1 // indirect
-	github.com/decred/dcrd/dcrutil/v4 v4.0.1 // indirect
+	github.com/decred/dcrd/dcrutil/v4 v4.0.2-0.20231005000813-c102e54b4128 // indirect


Did we need this for something?

This is to incorporate decred/dcrd#3196

peterzen mentioned this pull request Oct 26, 2023

dexc-desktop: flatpak and snap distribution #2581

Open

13 tasks

peterzen force-pushed the snapcraft-builder branch 3 times, most recently from 95e4276 to fc32448 Compare October 27, 2023 22:19

peterzen force-pushed the snapcraft-builder branch from 765346c to bf46fe3 Compare November 3, 2023 16:44

peterzen mentioned this pull request Nov 3, 2023

dexc-desktop: Icons, deb builder and metadata fixes #2582

Closed

peterzen marked this pull request as ready for review November 3, 2023 16:51

JoeGruffins reviewed Nov 15, 2023

View reviewed changes

client/cmd/dexc-desktop/README.md Outdated Show resolved Hide resolved

peterzen force-pushed the snapcraft-builder branch 2 times, most recently from bf46fe3 to 9bf282c Compare November 15, 2023 21:58

JoeGruffins approved these changes Nov 16, 2023

View reviewed changes

buck54321 requested changes Nov 26, 2023

View reviewed changes

peterzen force-pushed the snapcraft-builder branch from 1ffa951 to 97a53e9 Compare December 18, 2023 15:19

buck54321 reviewed Jan 17, 2024

View reviewed changes

peterzen added 4 commits January 22, 2024 14:05

Implemented snap package build

d2fb23e

Updated metadata

759c51b

Build site bundle if does not exist, fix metainfo directory

efeaebb

Doc improvements

f845d98

peterzen force-pushed the snapcraft-builder branch from 97a53e9 to f845d98 Compare January 26, 2024 20:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dexc-desktop: Snap package #2580

dexc-desktop: Snap package #2580

peterzen commented Oct 26, 2023 •

edited

JoeGruffins left a comment

peterzen commented Nov 15, 2023 •

edited

JoeGruffins commented Nov 16, 2023

JoeGruffins left a comment

buck54321 left a comment

peterzen commented Nov 27, 2023

buck54321 Jan 17, 2024

peterzen Jan 22, 2024

buck54321 Jan 17, 2024

peterzen Jan 22, 2024

buck54321 Jan 17, 2024

peterzen Jan 26, 2024

buck54321 Jan 17, 2024

peterzen Jan 26, 2024

buck54321 Jan 17, 2024

peterzen Jan 22, 2024

buck54321 Jan 17, 2024

peterzen Jan 22, 2024

dexc-desktop: Snap package #2580

Are you sure you want to change the base?

dexc-desktop: Snap package #2580

Conversation

peterzen commented Oct 26, 2023 • edited

JoeGruffins left a comment

Choose a reason for hiding this comment

peterzen commented Nov 15, 2023 • edited

JoeGruffins commented Nov 16, 2023

JoeGruffins left a comment

Choose a reason for hiding this comment

buck54321 left a comment

Choose a reason for hiding this comment

peterzen commented Nov 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peterzen commented Oct 26, 2023 •

edited

peterzen commented Nov 15, 2023 •

edited