Skip to content
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

fix broken github URLs #164

Merged
merged 4 commits into from
Aug 14, 2024
Merged

fix broken github URLs #164

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c8a909
fix broken github URLs
zkamvar Jul 22, 2024
3b342a3
Bump version
richfitz Aug 14, 2024
3e93979
Actually bump the version
richfitz Aug 14, 2024
432dc8e
Merge remote-tracking branch 'upstream/main' into znk/fix-broken-gith…
richfitz Aug 14, 2024
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
8 changes: 4 additions & 4 deletions vignettes/metadata.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,19 +81,19 @@ archive/

## Configuration (`.outpack/config.json`)

The outpack configuration schema is defined in [`config.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/outpack/schema/config.json)
The outpack configuration schema is defined in [`config.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/schema/outpack/config.json)

The configuration format is still subject to change...

## Packet metadata (`.outpack/metadata/`)

Each file within this directory has a filename that is an outpack id (matching the regular expression `^[0-9]{8}-[0-9]{6}-[0-9a-f]{8}$`, see below. Each file is a json file conforming to the schema [`metadata.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/outpack/schema/metadata.json).
Each file within this directory has a filename that is an outpack id (matching the regular expression `^[0-9]{8}-[0-9]{6}-[0-9a-f]{8}$`, see below. Each file is a json file conforming to the schema [`metadata.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/schema/outpack/metadata.json).

Being present here means that an outpack implementation can report information back about a packet (when it was created, what files it contains, etc), but packet metadata are not very meaningful on their own; we want to know where they might have come from (a location that is distributing this packet) and if we have a copy of the packet locally.

## Location information (`.outpack/location/`)

This directory matches the regular expression `^[0-9]{8}$` (e.g., `457f4f2a`) and is a "location id" (see below) corresponding to a "location". Each file within this directory has an outpack id as name, and contains json about when that location unpacked (or installed) the packet, and the hash of the metadata. This file conforms to the schema [`location.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/outpack/schema/location.json).
This directory matches the regular expression `^[0-9]{8}$` (e.g., `457f4f2a`) and is a "location id" (see below) corresponding to a "location". Each file within this directory has an outpack id as name, and contains json about when that location unpacked (or installed) the packet, and the hash of the metadata. This file conforms to the schema [`location.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/schema/outpack/location.json).

## A file store (`.outpack/files`)

Expand Down Expand Up @@ -137,7 +137,7 @@ For your local location id, write out a file
.outpack/<local location id>/<packet id>
```

conforming to the [`location.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/outpack/schema/location.json) schema, and containing the packet id, the time that it was marked as unpacked and the hash of the metadata.
conforming to the [`location.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/schema/outpack/location.json) schema, and containing the packet id, the time that it was marked as unpacked and the hash of the metadata.

## Ordering of operations

Expand Down
Loading