Snapcraft.yaml schema

farshidtz · August 12, 2022, 3:18pm

Missing a hyperlink: https://www.freedesktop.org/software/systemd/man/systemd.service.html#RestartSec=

degville · August 23, 2022, 10:16am

Now added - thanks for the suggestion/fix!

rpjday · January 20, 2023, 10:11am

I believe the first entry here, “name”, also has a max length of 40 characters.

rpjday · January 20, 2023, 10:34am

I see no reference to “build-base”, should that not be mentioned here?

rpjday · January 20, 2023, 10:43am

This claims that “version-script” is deprecated, but in the current snapcraft/projects.py schema file, it does not even appear. And as far back as 2019 in snapcraft code:

git show ab7c81969718e2ef10788f1d676a1e83245d3b44

Raise error if version-script is used, it’s being deprecated in favour of snapcraftctl set-version scriptlet.

Or maybe I’m misreading that. Is it deprecated or truly dead?

degville · January 23, 2023, 8:45pm

Thanks for flagging those issues. I’ve updated the page accordingly and I think I’ll add a note to say version-script applies only to legacy versions of Snapcraft, as I think it probably still works with those eg. 4.x/stable (I checked but couldn’t get it building).

rpjday · March 5, 2023, 10:52am

While the keywords ‘build-packages’, ‘build-snaps’, ‘stage-packages’ and ‘stage-snaps’ are defined here as being under the “parts:” hierarchy, are they not also available at the meta-data (root) level of a snapcraft.yaml file?

Wait, that probably should have said that just the “build-” keywords should be listed as global.

rpjday · March 5, 2023, 10:57am

Should this list not include the “epoch:” keyword?

rpjday · March 5, 2023, 11:30am

I see no mention of the top-level ‘package-repositories’ keyword. Additionally, I’m cross-checking the list here, https://github.com/rpjday/craft-parts/blob/main/craft_parts/parts.py#L33-L64, and a number of those variables don’t seem to be mentioned on this page: disable-parallel, and the three overlay-* variables. Also, the filesets keyword is gone for now, not clear if it is returning. Oh, and there’s that “permissions” keyword, I am unfamiliar with that one.

degville · March 6, 2023, 6:29pm

Thanks for flagging these. I’ve added epochs and package-repositories and will look into the others (disable-parallel seems old, but I can see what it does).

And sorry if I’m missing something obvious, but what’s the advantage of listing the build-* keywords as global keywords? How might they be used in this way? Thanks!

rpjday · March 6, 2023, 7:06pm

They can be listed globally to just install all those packages/snaps in the build environment, regardless of which part is being built.

degville · March 6, 2023, 7:46pm

Thanks - I’ll add them!

rpjday · March 8, 2023, 10:04am

I have a few more snapcraft keywords that don’t appear to be listed here:

aliases (might be deprecated/obsolete)
completer
bus-name
activates-on
daemon-scope

You can cross-check against https://github.com/snapcore/snapcraft/blob/main/snapcraft/projects.py#L236

degville · March 8, 2023, 11:17am

Brilliant, thank you - I’ll make sure they’re added/investigated and I’ll update this comment when they’re done.

pedronis · March 8, 2023, 3:22pm

yes, this is obsolete, I wouldn’t bother documenting at this point

this is part of an experimental feature (user services)

rpjday · March 8, 2023, 3:45pm

I think that might be the entirety of my proofreading.

ca-scribner · May 16, 2023, 6:00pm

For items like parts.<part-name>.organize, can we add to the description in which environment the file path in the key exists? For example with stage, I think it would be “In the key/value pair, the key represents the path of a file inside the part install directory and the value represents how the file is going to be staged”? This took some trial and error to figure out when doing an override-build first so I knew where to put my build artifacts to be reached by organize

ctlcltd · May 25, 2023, 2:56pm

Is there an error in the docs here: https://snapcraft.io/docs/snapcraft-yaml-reference ?

parts.<part-name>.parse-info Type: string but snapcraft refuses it as string, it wants list.

degville · May 25, 2023, 4:34pm

Thank for flagging this. I think you’re correct - I’ve updated the doc.

nuccitheboss · September 1, 2023, 4:40pm

Seems like for parts.<part-name>.source-type, a few of the allowed enum values get cut off and replaced by an ellipsis ... when viewing the documentation through snapcraft.io:

I figured tar would be an acceptable source type, but I could only verify this by clicking to view the discourse page instead. Could we potentially change the page setting so that longer code blocks are not truncated and replaced with an ellipsis and instead wrap to the next line?