@smthrs/artifacts 1.0.0-rc.6 → 1.0.0-rc.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ This package declares `effect` as a `^4.0.4` peer dependency. Install one
|
|
|
6
6
|
`effect` release in that range so all Smithers packages share one Effect
|
|
7
7
|
runtime.
|
|
8
8
|
|
|
9
|
-
**Documentation:** https://
|
|
9
|
+
**Documentation:** https://github.com/smithersai/smithers/tree/main/packages/smithers/flows/artifacts/docs
|
|
10
10
|
|
|
11
11
|
The content-addressed artifact store: bytes addressed by their own SHA-256
|
|
12
12
|
digest. You hand it a `Uint8Array`, it hands back a 64 character address, and
|
|
@@ -92,7 +92,7 @@ modification time fence, and `ArtifactBackupLease` keeps a sweep from deleting
|
|
|
92
92
|
a blob a running backup is still copying.
|
|
93
93
|
|
|
94
94
|
Every export, option, and error code is in the
|
|
95
|
-
[API reference](https://
|
|
95
|
+
[API reference](https://github.com/smithersai/smithers/blob/main/packages/smithers/flows/artifacts/docs/api.md).
|
|
96
96
|
|
|
97
97
|
## What it guarantees
|
|
98
98
|
|
|
@@ -133,7 +133,7 @@ caller-owned buffer, and every successful `get` returns a new byte array.
|
|
|
133
133
|
`ArtifactMissing` is an ordinary miss, and `ArtifactCorruption` is an integrity
|
|
134
134
|
failure. `digest_failed`, `unavailable`, and `transport_failed` describe host
|
|
135
135
|
or transport failures whose retryability depends on the host and operation.
|
|
136
|
-
[Troubleshooting](https://
|
|
136
|
+
[Troubleshooting](https://github.com/smithersai/smithers/blob/main/packages/smithers/flows/artifacts/docs/troubleshooting.md) lists each
|
|
137
137
|
one with what to change.
|
|
138
138
|
|
|
139
139
|
## Prior art
|
|
@@ -149,14 +149,14 @@ the fsync before the rename are
|
|
|
149
149
|
and the wire protocol, CAS blobs under `/cas/base16-key`, is
|
|
150
150
|
[`HttpCacheClient`](https://github.com/bazelbuild/bazel/blob/master/src/main/java/com/google/devtools/build/lib/remote/http/HttpCacheClient.java).
|
|
151
151
|
Where this package deviates, and why, is in
|
|
152
|
-
[content addressing](https://
|
|
152
|
+
[content addressing](https://github.com/smithersai/smithers/blob/main/packages/smithers/flows/artifacts/docs/concepts/content-addressing.md).
|
|
153
153
|
|
|
154
154
|
## Where it fits
|
|
155
155
|
|
|
156
156
|
This package is one piece of the Smithers durable flow engine, whose whole
|
|
157
|
-
surface is re-exported by [`@smthrs/flows`](https://
|
|
157
|
+
surface is re-exported by [`@smthrs/flows`](https://github.com/smithersai/smithers/tree/main/packages/smithers/flows/docs). Inside
|
|
158
158
|
that engine the artifact store is the byte half of the result cache:
|
|
159
|
-
[`@smthrs/step-cache`](https://step-cache
|
|
159
|
+
[`@smthrs/step-cache`](https://github.com/smithersai/smithers/tree/main/packages/smithers/flows/step-cache/docs) records what a step
|
|
160
160
|
returned, and any part of that result too large to sit inline is spilled here
|
|
161
161
|
and referenced by digest.
|
|
162
162
|
|
|
@@ -167,7 +167,7 @@ Reclaiming published artifacts is an explicit operation, never a side effect of
|
|
|
167
167
|
a store call. The `.tmp-*` sweep in `layerFileSystem` reclaims crash orphans
|
|
168
168
|
only. `ArtifactSweep` is the deletion surface, and the mark phase that decides
|
|
169
169
|
what is live belongs to
|
|
170
|
-
[`@smthrs/engine-store`](https://engine-store
|
|
170
|
+
[`@smthrs/engine-store`](https://github.com/smithersai/smithers/tree/main/packages/smithers/flows/engine-store/docs).
|
|
171
171
|
|
|
172
172
|
## License
|
|
173
173
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@smthrs/artifacts",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.0.0-rc.
|
|
4
|
+
"version": "1.0.0-rc.7",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"smthrs": {
|
|
7
7
|
"group": "engine"
|
|
@@ -145,7 +145,7 @@
|
|
|
145
145
|
"tag": "next"
|
|
146
146
|
},
|
|
147
147
|
"dependencies": {
|
|
148
|
-
"@smthrs/crypto": "1.0.0-rc.
|
|
148
|
+
"@smthrs/crypto": "1.0.0-rc.7"
|
|
149
149
|
},
|
|
150
150
|
"devDependencies": {
|
|
151
151
|
"@effect/language-service": "0.87.2",
|