Skip to content

Commit 0aee21d

Browse files
committed
(human) some doc updates, version value bumps, other cleanup/polish
1 parent 456c549 commit 0aee21d

File tree

7 files changed

+475
-183
lines changed

7 files changed

+475
-183
lines changed

examples/env/README.md

Lines changed: 41 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -426,55 +426,59 @@ Generally speaking...
426426
```
427427
Dir add a directory
428428
File add a file
429+
430+
Changes applies #Changes to a container
431+
Patch applies a git-like patch or #Changes
432+
PatchFile applies a #PatchFile
433+
RootFS set the root FS of a container
434+
429435
EnvVars add a set of env vars
430436
SecretVars add a set of secret vars
431437
EnvFile add an env var file
432438
SecretFile add a secret var file
433439
434-
Temp a temp volume for the next exec
435-
Mount mount a cache, file, directory, secret
436-
UnixSocket mount a unix socket at a path
437-
BindService bind another service to the container (hint, dep graph)
438-
Expose mark a port for servin
439-
440440
Sync force evaluation of the dagger graph
441441
Exec run any command as a container layer
442442
Sh, Bash, Zsh exec wrappers with a 'script' param
443443
User set the current user
444444
Workdir set the current workdir
445445
446-
447446
Entrypoint set container entrypoint
448447
DefaultArgs set container default args
449448
DefaultTerm set the terminal dagger uses when needed
449+
Terminal start a terminal at any or many point(s), directory or container
450450
451-
!!!
452-
Terminal drop into a terminal at any or many point(s), directory or container
453-
!!! (this is one of the coolest dagger features)
451+
Temp a temp volume for the next exec
452+
Mount mount a cache, file, directory, secret
453+
UnixSocket mount a unix socket at a path
454+
BindService bind another service to the container (hint, dep graph)
455+
Expose mark a port for servin
454456
455-
More to come...
457+
these all remove from a container as a new layer
458+
WithoutDefaultArgs
459+
WithoutDirectory
460+
WithoutEntrypoint
461+
WithoutEnvVariable
462+
WithoutExposedPort
463+
WithoutFile
464+
WithoutFiles
465+
WithoutLabel
466+
WithoutMount
467+
WithoutRegistryAuth
468+
WithoutSecretVariable
469+
WithoutUnixSocket
470+
WithoutUser
471+
WithoutWorkdir
472+
```
473+
<!-- More to come...
456474
457475
- VsCode (like terminal, combo of them too)
458476
- Chown
459-
- $Filter (#Dir->#Dir)
460-
- $Diff (#Dir-#Dir->#Dir)
461-
- Patch & #Patch
462-
- Diff & #Diff, Changes & #Changeset
463477
- ?Merge (not overwrite, doesn't exist yet)
464478
- #DirToGit git from a dir
465479

466-
Vscode (we'll add a Step to open in vscode, or make something that does both, configurablely)
480+
Vscode (we'll add a Step to open in vscode, or make something that does both, configurablely) -->
467481
468-
Without...
469-
-- both #Dir and #Container
470-
Dir
471-
File
472-
Files
473-
-- #Containers only
474-
EnvVar
475-
SecretVar
476-
477-
```
478482
479483
### #Stuff:
480484
@@ -489,6 +493,11 @@ These are artifacts, intermediates, or resources you can work with
489493
#File a file that can be used in CUE
490494
#Secret a secret that will be elided from output
491495
#Cache a named volume in memory, persists sessions
496+
#RootFS get the root FS for a container
497+
498+
#Changes calculate the diff between two directories
499+
#PatchFile convert #Changes into a patch #File
500+
#Shouldi condition evaluation based on git diffs
492501
493502
#Cmd a custom command with named subtasks
494503
#Task a task is a list of runnables and is runnable itself
@@ -501,16 +510,20 @@ These are artifacts, intermediates, or resources you can work with
501510
#HostService expose host to dagger
502511
#HostTunnel expose dagger to host
503512
#HostSocket from a path
513+
#HostExec run a command on the host (!outside of containers!)
504514
505515
#ExportDir to host path
506516
#ExportFile to host path
507517
#ExportImageFile to a tarball
508518
#ExportImage to local engine
509519
#PublishImage to a registry
510520
521+
522+
# helpers, not #things, but work / make them
523+
#Flatten create a new container from scratch and an existing container or directory
524+
511525
# many data formats available
512-
#ExportCuefig returns a #File for the CUE representation any #Thing
513-
#ExportDagger returns a #File for the Dagger representation any #Thing
526+
#CuefigSBOM returns a #File with the CUE/Dagger representation for any #Thing
514527
```
515528
516529
## Examples

extensions/vscode/extension/package.cue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ displayName: "Veg"
55
description: "Veg VS Code Extension"
66
repository: "github.com/hofstadter-io/hof"
77
publisher: "verdverm"
8-
version: "0.0.1"
8+
version: "v0.7.0-alpha.2"
99
engines: {
1010
vscode: "^1.106.0"
1111
}

extensions/vscode/extension/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"description": "Veg VS Code Extension",
55
"repository": "github.com/hofstadter-io/hof",
66
"publisher": "verdverm",
7-
"version": "0.0.1",
7+
"version": "v0.7.0-alpha.2",
88
"engines": {
99
"vscode": "^1.106.0"
1010
},

schemas/env/diff.cue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Changes: Step & {
3939
source: string | #Changes
4040
}
4141

42-
// patch a #Container with a git-lie patch or #Changes
42+
// patch a #Container with a git-like patch or #Changes
4343
Patch: Step & {
4444
$kind: "patch"
4545
source: string | #Changes

schemas/env/route.cue

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
package env
2+
3+
#Method: *"GET" | "POST" | "PUT" | "DELETE" | "OPTIONS" | "HEAD" | "CONNECT" | "TRACE" | "PATCH"
4+
5+
#Route: Ref & {
6+
// normal http / rest stuff
7+
// webhook / other validation
8+
9+
path: string
10+
method: #Method
11+
12+
13+
input: {
14+
url: string
15+
16+
headers: [string]: string
17+
query: [string]: string
18+
19+
body: bytes | string | *{} // assumed json body if object
20+
}
21+
22+
// some #Thing that get's Sync/Export/Etc...
23+
vegOp: "SYNC" | "EXPORT" | "CMD"
24+
handler: _
25+
26+
27+
routes: [...#Route]
28+
}
29+

schemas/env/sbom.cue

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,6 @@ import (
55
)
66

77

8-
// supported formats for sbom generators
9-
10-
// common fields for sbom generators, used internally
11-
sbomCommon: {
12-
name?: string
13-
path: string
14-
data: _
15-
}
16-
178
// generate the CUE representation
189
// is a: *dagger.File with format:[cue,json,yaml,toml] content
1910
// data: any CUE value
@@ -27,23 +18,9 @@ sbomCommon: {
2718
$kind: "#cuefigSBOM"
2819
format: or(["cue", "json", "yaml", "toml"])
2920

30-
sbomCommon
21+
name?: string
22+
path: string
23+
data: _
3124
}
3225

33-
// generate the Dagger representation
34-
// is a: *dagger.File with JSON content
35-
// data: any *dagger.Object (env.Ref, i.e. #Things)
36-
// hmmm, can we reverse this one?
37-
// update, can't seem to get anything reasonable out of dagger for sbom, misleading function names / what they return, it's all internal ids to ephemeral object, not actual sbom material
38-
// #DaggerSBOM: Ref & {
39-
// schemas.Hof
40-
// #hof: env: {
41-
// root: true // need to figure out what this really means, how it interacts with discovery & cli vs walking a CUE value to construct a giant dagger dag
42-
// kind: "daggerSBOM"
43-
// }
44-
// $kind: "#daggerSBOM"
45-
46-
// sbomCommon
47-
// }
48-
4926
// TODO, sigstore/cosign stuff

0 commit comments

Comments
 (0)