spkenv / spk

A Package Manager for high velocity software environments, built on spfs.
https://spkenv.dev
Apache License 2.0
40 stars 6 forks source link

Doc improvement - spfs config remote #1085

Closed doubleailes closed 3 months ago

doubleailes commented 3 months ago

Is your feature request related to a problem? Please describe. Following the doc chapter installation and bootstrapping option1 result in:

spk build python.spk.yaml
 INFO rendering template for python
 INFO saving package recipe for python/3.11.9
 INFO collecting sources for python/3.11.9
 INFO Validating source package contents...
 INFO Committing source package contents...
Error: spfs::unknown_remote (https://spkenv.dev/error_codes#spfs::unknown_remote)

  × No remote named 'origin' configured
  help: See available remotes via the 'spfs config' command

Error:   × Failed to spawn spfs-render
  ╰─▶ process exited with non-zero status

ERROR spfs::generic (https://spkenv.dev/error_codes#spfs::generic)

  × Failed to collect sources
  ╰─▶ Failed to re-mount runtime filesystem: spfs-enter --remount failed with code Some(1)

Describe the solution you'd like I guess a step is missing in the documentation to setup spfs config remote before building package

rydrman commented 3 months ago

Thanks for this! I've put in a few changes to not require the config file which I think is better for reducing friction overall