diff --git a/docs/use/_index.md b/docs/use/_index.md index 16a253fd7e..43122c920d 100644 --- a/docs/use/_index.md +++ b/docs/use/_index.md @@ -45,6 +45,8 @@ For more detailed information on the build process, check the [Package Build Pro $ spk publish my-pkg/0.1.0 ``` +For more detailed information on the publishing process, check out [Publishing Packages]({{< ref "./publishing_packages" >}}) + ### Run an Environment In The Past For debugging and recovery workflows, the `--when` flag can be provided to run spk commands diff --git a/docs/use/publishing_packages.md b/docs/use/publishing_packages.md new file mode 100644 index 0000000000..a9e697cf9b --- /dev/null +++ b/docs/use/publishing_packages.md @@ -0,0 +1,36 @@ +--- +title: Publishing Packages +summary: Publish locally built packages for others to use. +weight: 20 +--- + +Packages built with `spk build` are only installed to your configured +local storage path via the root storage key in the SPFS +configuration file: + +```toml +[storage] +root = "~/.local/spfs" +``` + +In order to be accessible by other members of your team, you need to +publish your packages. This can be done via the `spk publish` command: + +```console +$ spk publish my-pkg/0.1.0 +``` + +This will copy an already built local package called `my-pkg` to +the configured `remote.origin` address in the SPFS configuration +file: + +```toml +[remote.origin] +address = "file:/tmp/spfs-origin" +``` + +This address can either be a local filesystem path, a NFS path, or +a SPFS server instance. + +I'm not sure if the `spk publish` command does anything else. +Need help here.