goreleaser: init snap, linux shell completions

[jzelinskie]

Shoutouts to @jnsgruk and @caarlos0 for guidance around snaps and packaging completion for goreleaser!

[jnsgruk]

Hey Jimmy, do you need any assistance moving this forward? There's some simple CI work we could do to start pushing this out to edge on merges to main if that's something you'd like to experiment with?

[jzelinskie]

Thanks for checking in @jnsgruk.

I've got snaps building.

I took a bit longer for this PR because I also added shell completions to our Linux packages; is there a standard way to add this for snaps? Otherwise I'm ready to take your lead on how to get things pushed to the snap store.

[jnsgruk]

Great! Yep there is a standard way to do that: https://snapcraft.io/docs/tab-completion

There is an example here: https://github.com/canonical/multipass/blob/8c7a2266f7c084ff81611409da0d3c71c0a8fbbc/snap/snapcraft.yaml#L85

[jzelinskie]

It looks like my last commit does the trick, but it doesn't follow the snap.spicedb naming convention.

What's next to get this plugged into the snap store channels?
We've got another goreleaser config and workflow for pushing builds of main that'd be trivial to update with the snaps.

[jnsgruk]

Next step would be to register your snap name. I'd recommend using a company account for signing up to snapcraft.io (like [email protected] or similar) so we can get it verified later.

Once you've signed up and registered, you'll need to export a token and set it in Github Actions secret as the variable SNAPCRAFT_STORE_CREDENTIALS.

Finally - set up a job that publishes the *.snap files [like this] (https://github.com/parca-dev/parca/blob/c14c86b662c8c7cb12c633e6e0c668af20cc4dbb/.github/workflows/release.yml#L187-L206). The other option might just be to set publish: true in your snapcrafts section of goreleaser, but I've got less experience with how to auth that etc.

[jnsgruk]

Looking at the goreleaser docs, you may need something like so in your snapcrafts section:

extra_files:
      - source: completions/spicedb.bash
        destination: completions/spicedb.snap
        mode: 0755

Which will actually stage the completer, with the bonus that you can follow the snapcraft naming convention?

[jzelinskie]

I'm not sure why, but extra_files appears to do nothing and I can only get completer to include the file when it ends with .bash and not .snap. @caarlos0 am I doing something wrong? I'm testing by running unsquashfs on the snap and inspecting the contents.

[jzelinskie]

Sorry about this -- I was traveling for KubeCon and on vacation. Getting back to it soon.

[jzelinskie]

@jnsgruk is the naming convention there a dealbreaker? I'd like to get this moving along and maybe we can go back and address that after we kick the tires with some of the publishing pipeline.

[jnsgruk]

Hey @jzelinskie! I did a bit of digging this morning, and I think the naming is fine.

I also came across this guide for debugging it if we run into problems. I note that in the example there they use:

name: foo
version: v1
apps:
  bar:
    command: bar
    completer: bar-completer.sh # this is the one!

So I think you're good!

[josephschorr]

LGTM