← Back to issue list

snapcraft shouldn't complain about snap/README.md

View original Launchpad issue

Metadata

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

Current evaluation

Snapcraft’s current snap-directory allowlist still rejects snap/README.md; the long-open request remains untriaged and has no maintainer feedback.

Suggested action: needs triage

Reason: The current _EXPECTED_SNAP_DIR_PATTERNS has no README exemption, and project checks run before provider delegation, supporting the report of duplicate warnings. Adding an allowlist case and unit coverage is straightforward, but no labels, comments, or maintainer response show that the request has been assessed.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 21 Complexity: 15 Confidence: 94 Actionability: 83

Issue body

For some projects, such as edgex-go (and the edgexfoundry snap), there is an extensive amount of documentation surrounding the snap, and so we have a README.md specific to the snap in the snap/ dir in the root of the project, living alongside the snapcraft.yaml. We migrated all the rest of the scripts, icons, etc. for the snap into the snap/local/ dir, but we would like to keep the README.md in the snap/ dir because it's useful for folks wanting to look at the snap to just click on the snap dir in github and see the markdown generated right there. As such, we'd like to see snap/README.md ignored from the check for additional files in the snap/ folder to remove this warning every time we build the snap: ``` $ snapcraft The 'snap' directory is meant specifically for snapcraft, but it contains the following non-snapcraft-related paths, which is unsupported and will cause unexpected behavior: - README.md If you must store these files within the 'snap' directory, move them to 'snap/local', which is ignored by snapcraft. ``` Also note that this message is issued twice, once before launching the multipass VM, and again after the multipass VM has been started.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 30
Quick Win: 21
Complexity: 15
Confidence: 94
Actionability: 83
needs triage Snapcraft’s current snap-directory allowlist still rejects snap/README.md; the long-open request remains untriaged and has no maintainer feedback.
stealth/space-bunny-alpha
Impact: 30
Quick Win: 15
Complexity: 28
Confidence: 80
Actionability: 70
needs triage Request to whitelist snap/README.md (and stop the duplicate warning) in snapcraft's snap/ directory extra-file check; still unimplemented, no maintainer response.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 70
Actionability: 80
keep open Request to allow README.md in snap/ directory without triggering unsupported-file warnings
qwen/qwen3.8-27b
Impact: 15
Quick Win: 11
Staleness: 95
Complexity: 25
Confidence: 62
Support Request: 65
close not a bug Request to stop snapcraft warning about snap/README.md as a non-snapcraft path so docs can live in the snap/ dir. 7 years old, zero comments, no labels or maintainer response; the warning is intentional and already documents the snap/local/ workaround.
qwen/qwen3.6-35b-a3b
Staleness: 98
Complexity: 10
Confidence: 90
Support Request: 10
close stale Request to suppress snapcraft warnings for snap/README.md. The issue is over six years old, has zero comments, and shows no maintainer engagement or resolution.
qwen/qwen3.6-35b-a3b
Staleness: 95
Complexity: 15
Confidence: 85
Support Request: 10
close stale Request to suppress snapcraft warnings for snap/README.md files. Unlabeled, zero comments, and inactive for nearly seven years, indicating likely obsolescence.
qwen3.6-35b-a3b-mtp-q6
Staleness: 95
Complexity: 20
Confidence: 85
Support Request: 10
close stale Request to ignore snap/README.md from snapcraft's warning about non-snapcraft files in the snap directory. Issue is over 6 years old with no maintainer response or labels.

Update history

Date Change
created

Related work

  • Caused By: snapcraft (launchpad)#1791368 (confidence 98%)

    This change introduced the unsupported snap-directory warning whose allowlist currently excludes README.md.

  • Related To: snapcraft (launchpad)#1792078 (confidence 96%)

    It also requests exemption for README files, although its README is under snap/hooks and discussion identified the snapd check as the underlying source.

  • Related To: snapcraft (launchpad)#1795780 (confidence 91%)

    It requests suppression of the same snap-directory warning for an editor backup file.

Related issues

Issue Project State Summary Similarity
#1792078 Snapcraft complain on a non-executable hook named `README.md` snapcraft (launchpad) open Snapcraft rejects a documentation-only snap/hooks/README.md; maintainers attributed the failure to snap check and proposed exempting non-executable README files, but no fix is recorded.
79%