Skip to content

simplify deb installation docs#3672

Merged
vilmibm merged 4 commits intotrunkfrom
deb-doc
May 20, 2021
Merged

simplify deb installation docs#3672
vilmibm merged 4 commits intotrunkfrom
deb-doc

Conversation

@vilmibm
Copy link
Contributor

@vilmibm vilmibm commented May 19, 2021

Fixes #3513
Fixes #2893
Fixes #1827

This PR removes two tools from our .deb installation docs (apt-key, apt-add-repository). It also links to our GPG key on cli.github.com instead of on the ubuntu keyserver.

Hopefully this leads to a smoother installation experience across the various .deb distros.

Additionally, this PR adds explicit packaging for Debian Sid (the codename for unstable). We already packaged for sid, but only listed unstable and not sid. Typically, one could just symlink unstable to sid (as #1827 suggests) but unfortunately that doesn't work with GitHub Pages. It seems like we could allow symlinking with GitHub pages, but it wasn't immediately clear to me how to do so (or if we ought to). So for now, I've just added sid to our distributions file.

For reference: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites#file-is-a-symlink

NB: if we are able to enable the symlinking, I could shorten our distributions file considerably and not require so many code names in the release workflow yaml.

@vilmibm vilmibm requested review from mislav and samcoe May 19, 2021 21:18
Copy link
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already so much better. Thank you!


**Note**: If you get _"gpg: failed to start the dirmngr '/usr/bin/dirmngr': No such file or directory"_ error, try installing the `dirmngr` package. Run `sudo apt-get install dirmngr` and repeat the steps above.

**Note**: most systems will have `apt-add-repository` already. If you get a _command not found_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yess all those notes gone 🔥🔥🔥

### Debian, Ubuntu Linux (apt)

Install (Using apt-key):
:warning: This will only work for the deb-based distributions we [explicitly support](/.github/workflows/releases.yml#L83) and the [architectures we officially support](/.goreleaser.yml#L27).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why couldn't we allow anyone with a Debian derivative to fetch our deb package, regardless of what their lsb_release -cs reports? I.e. instead of evaluating lsb_release -cs, we put some static string in sources.list, like "stable".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can do that, though it can lead to annoying behavior with certain distributions especially around distro upgrade time. I'll put stable for now but leave a note about how a more specific codename can be used if desired.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants