← Back to issue list

snapcraft shouldn't complain about snap/README.md

View original Launchpad issue

Metadata

Project
snapcraft
Number
#1845276
Type
issue
State
open
Author
~anonymouse67
Labels
Created
2019-09-24 23:14:37.424615+00:00
Updated
2020-08-26 18:20:32.649569+00:00
Closed

Current evaluation

No evaluation has been recorded for this issue yet.

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

No evaluation history available.