← Back to issue list

No explanation for using local GPG keys

View original Github issue

Metadata

Project
craft-archives
Number
#190
Type
issue
State
open
Author
dilyn-corner
Labels
Status: Triaged Type: Documentation Type: Enhancement
Created
Updated
Closed
—

Current evaluation

Docs gap: repo_properties.rst and how-to/add_repo.rst document key-id and key-server but never explain that local key assets (snap/keys/<last8upper>.asc) take priority over the keyserver. Triaged by lengau, still open.

Suggested action: keep open

Reason: Maintainer lengau explicitly triaged and split this into two parts ('1. This above, as an app author would use it. 2. Same but user-facing for snapcraft'), and it carries a Status: Triaged label plus internal ticket CRAFT-4692, so it is valid and acknowledged rather than abandoned. I verified at the current HEAD that the gap persists: docs/reference/repo_properties.rst documents key-id and key-server (defaulting to keyserver.ubuntu.com) but never mentions local key assets, while AptKeyManager.find_asset_with_key_id() resolves them as snap/keys/<last8upper>.asc and install_package_repository_key() prefers them over the keyserver. Uncertainty is moderate because the snap/keys path itself lives in a downstream consumer (snapcraft), so part 2 needs cross-repo coordination and the exact path is not defined in this repo.

Evaluated by: mr-cal-bot

Impact: 48 Quick Win: 32 Complexity: 22 Confidence: 82 Actionability: 85

Issue body

https://github.com/canonical/craft-archives/blob/7c35cc475af18f1525e75b206e828a3b1bf23a38/docs/reference/repo_properties.rst?plain=1#L2 The documentation does not explain how to use a local GPG key instead of relying on a key server. For instance I would expect this explanation to be somewhere: https://github.com/canonical/craft-archives/blob/7c35cc475af18f1525e75b206e828a3b1bf23a38/craft_archives/repo/apt_key_manager.py#L81-L98 Along with the path the key must be in (`snap/keys/lasteightcharacters.asc`), and that local keys would be privileged over remote keys: https://github.com/canonical/craft-archives/blob/7c35cc475af18f1525e75b206e828a3b1bf23a38/craft_archives/repo/apt_key_manager.py#L249-L253 In general, an explanation on how to get the ASC, identify the fingerprint, and the ID would be exceptionally useful (as most people are still quite unaware of how GPG works or what these things mean...)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 48
Quick Win: 32
Complexity: 22
Confidence: 82
Actionability: 85
keep open Docs gap: repo_properties.rst and how-to/add_repo.rst document key-id and key-server but never explain that local key assets (snap/keys/<last8upper>.asc) take priority over the keyserver. Triaged by lengau, still open.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 19
Complexity: 20
Confidence: 80
Actionability: 80
keep open Documentation enhancement request to explain how to use local GPG keys instead of relying on a key server in craft-archives.
qwen/qwen3.8-27b
Impact: 35
Quick Win: 28
Staleness: 62
Complexity: 20
Confidence: 72
Support Request: 10
keep open Documentation gap: repo_properties.rst lacks explanation of local GPG key usage (snap/keys/<last8>.asc) for APT repos. Triaged, maintainer acknowledged, synced to Jira CRAFT-4692. Docstrings in package_repository.py now partially cover it, but RST docs still missing the explanation. Inactive ~12.7 months.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 20
Confidence: 85
Support Request: 10
keep open Documentation enhancement requesting guidance on using local GPG keys, including paths, privileges, and key identification. Currently triaged but inactive for over a year with a Jira ticket created.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 25
Confidence: 75
Support Request: 10
keep open Documentation enhancement requesting guidance on using local GPG keys instead of key servers, including key paths, privileges, and GPG basics. Currently triaged and linked to an internal Jira ticket, but inactive for ~11 months.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#5697 Explain how to use local GPG keys for a repository snapcraft open Triaged documentation gap remains: local GPG keys for custom package repositories lack guidance on the required key filename format and storage location.
75%