Skip to content

New remote spec #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tomodachi94 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

New remote spec #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 22 additions & 7 deletions src/v1.1.0/package-remotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,33 @@
**Package remotes** are a feature in unicornpkg that allow you to download package tables semi-automatically.
**Package remotes** are a feature in unicornpkg that allow you to download package tables semi-automatically from a server.

## Specification
### Remote

The remote is a simple HTTPS server. It's usually a GitHub repository, but other hosts should work fine.
The remote must be a simple HTTPS server. HTTP is allowed, but discouraged. Remotes may also be folders located anywhere in the filesystem. Write access to these filesystem-based remotes is not guaranteed, as some might be located in `/rom`.

Each package should be a file on the package remote ending in `.lua`.
Each package should be a file on the package remote ending in `.lua`. Each package should return the `text/lua` or `text/plain` MIME types.

All packages on the remote should return valid package tables.
All packages on the remote, when evaluated, should return valid package tables.

All packages and their versions should be listed in a JSON file (the "manifest") available at `/unicornpkg.remote.json` on the remote. The JSON file should look like this:

```jsonc
{
spec: "unicornpkg-1.1.0",
packages: {
"somepackage": "1.0.1",
"examplepackage": "1.2.3",
"anotherexamplepackage": null // No version available for this package; always specify a version where possible
}
}
```

This file should return the `application/json` MIME type. Manifests should be automatically updated by a script where possible.

### Retrieval on the client

The client will have a folder called `/etc/unicorn/remotes/` that will contain one serialised file per remote. Each serialised file should contain a `url` keyword specifiying the full HTTP path to the remote, as well as a `packages` table that contains known packages from that remote.
The client will have a folder called `/etc/unicorn/remotes/` that will contain one serialised file per remote. Each serialised file should contain a `url` keyword specifiying the full HTTPS path to the remote.

`unicorn.hoof.update()` should parse each file in `/etc/unicorn/remotes` and update the `packages` table.
`unicorn.hoof.update()` should parse each file in `/etc/unicorn/remotes` and check for validity. It should download each remote's manifest into `/var/unicorn/remotes/remotename.json`.

`unicorn.hoof.get()` should parse each file in `/etc/unicorn/remotes/` and download the requested file to `/tmp/unicorn/{package_name}.lua`, and then `unicorn.install()` should install said file.
`unicorn.hoof.get()` should parse each manifest in `/var/unicorn/remotes/`. It should evaluate the version strings, find the newest version for a package across all remotes, and then download and install the package table from the remote.