Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/use/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
36 changes: 36 additions & 0 deletions docs/use/publishing_packages.md
Original file line number Diff line number Diff line change
@@ -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.