← Back to issue list

export-login --acls are not documented

View original Launchpad issue

Metadata

Project
snapcraft (launchpad)
Number
#1858020
Type
issue
State
open
Author
~abitrolly
Labels
—
Created
Updated
Closed
—

Current evaluation

export-login --acls values still undocumented: CLI help and docs only link to the macaroon API reference; no per-ACL explanation/table. Maintainer agreed in 2020 it should be in help/docs; partial link-only fix landed in e40e68f37 (#6136).

Suggested action: keep open

Reason: The request remains valid and partially unimplemented: `snapcraft/commands/account.py:160-165` still documents --acls only as "Comma-separated list of ACLs to limit access", and `docs/how-to/publishing/authenticate.rst:61-63` only links out to the macaroon page (a link a reporter called a dead link in 2023), with no ACL values or semantics anywhere in-tree. Commit e40e68f37 ("docs: add link to valid ACLs (#6136)") addressed only the link, not the actual request. The exact content needed already exists in `snapcraft/store/client.py:266-274` (package_access, package_manage, package_metrics, package_push, package_register, package_release, package_update), so this is a well-scoped doc/help-text change; the auto-generated reference/commands pages inherit the same text, so fixing account.py fixes both. Keep open rather than close_stale because age is not grounds for closure, the subsystem is active, and ~cjp256 explicitly acknowledged it ("we should probably incorporate that into the help menu, or snapcraft docs?"). Impact is modest: it is documentation/UX friction, not a functional defect, though it blocks safe least-privilege CI token generation.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 21 Complexity: 12 Confidence: 88 Actionability: 80

Issue body

`snapcraft export-login -h` does not provide information about possible values of --acls key. I am using this command to generate token for Travis. snapcraft export-login --snaps=yakshaveinc --acls=package_push,package_upload --channels stable And I can't remember what's the difference between `package_push` and `package_upload`?

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 30
Quick Win: 21
Complexity: 12
Confidence: 88
Actionability: 80
keep open export-login --acls values still undocumented: CLI help and docs only link to the macaroon API reference; no per-ACL explanation/table. Maintainer agreed in 2020 it should be in help/docs; partial link-only fix landed in e40e68f37 (#6136).
stealth/space-bunny-alpha
Impact: 45
Quick Win: 28
Complexity: 25
Confidence: 91
Actionability: 84
keep open export-login documentation now links to the macaroon ACL reference but still does not explain individual ACL values; the request for a concise table remains open.
stealth/space-bunny-alpha
Impact: 28
Quick Win: 23
Complexity: 15
Confidence: 99
Actionability: 96
close resolved Resolved: export-login help now links to the complete ACL list, and the authentication guide documents --acls and points to valid values.
qwen/qwen3.8-27b
Impact: 15
Quick Win: 14
Staleness: 95
Complexity: 10
Confidence: 55
Support Request: 50
close stale Documentation gap: snapcraft export-login --acls help text does not list valid ACL values (e.g. package_push vs package_upload). Open 6.7 years, zero comments, no labels, no maintainer interaction.
qwen/qwen3.6-35b-a3b
Staleness: 95
Complexity: 10
Confidence: 90
Support Request: 65
close stale Missing documentation for snapcraft export-login --acls possible values. Open for over 6 years with no maintainer response or comments.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 20
Confidence: 80
Support Request: 60
needs triage Command help for --acls in snapcraft export-login lacks documentation on possible values and their differences. No maintainer interaction.
qwen3.6-35b-a3b-mtp-q6
Staleness: 95
Complexity: 10
Confidence: 80
Support Request: 75
close stale Documentation gap for snapcraft export-login --acls values. Issue remains unlabelled and untriaged after over six years with no maintainer engagement.

Update history

Date Change
created

Related work

  • Related To: canonical/snapcraft#6136 (confidence 80%)

    Commit e40e68f37 "docs: add link to valid ACLs (#6136)" is a partial fix that added only the off-site ACL reference link, leaving the request for enumerated ACL values/table open.

Related issues

No related issues found above the similarity threshold.