devlanes 0.4.4 → 0.6.0
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/package.json +7 -7
- package/schema.json +44 -6
- package/user-schema.json +86 -5
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "devlanes",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "Development environments in Git worktree lanes",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"homepage": "https://devlanes.run",
|
|
@@ -30,11 +30,11 @@
|
|
|
30
30
|
"node": ">=18"
|
|
31
31
|
},
|
|
32
32
|
"optionalDependencies": {
|
|
33
|
-
"@devlanes/darwin-arm64": "0.
|
|
34
|
-
"@devlanes/darwin-x64": "0.
|
|
35
|
-
"@devlanes/linux-arm64": "0.
|
|
36
|
-
"@devlanes/linux-x64": "0.
|
|
37
|
-
"@devlanes/win32-arm64": "0.
|
|
38
|
-
"@devlanes/win32-x64": "0.
|
|
33
|
+
"@devlanes/darwin-arm64": "0.6.0",
|
|
34
|
+
"@devlanes/darwin-x64": "0.6.0",
|
|
35
|
+
"@devlanes/linux-arm64": "0.6.0",
|
|
36
|
+
"@devlanes/linux-x64": "0.6.0",
|
|
37
|
+
"@devlanes/win32-arm64": "0.6.0",
|
|
38
|
+
"@devlanes/win32-x64": "0.6.0"
|
|
39
39
|
}
|
|
40
40
|
}
|
package/schema.json
CHANGED
|
@@ -401,6 +401,25 @@
|
|
|
401
401
|
],
|
|
402
402
|
"markdownDescription": "HTTP readiness probe against the unit's main port. Passes on a 2xx answer when `status` is unset, or on exactly `status` when it is set. Redirects are not followed.",
|
|
403
403
|
"properties": {
|
|
404
|
+
"host": {
|
|
405
|
+
"anyOf": [
|
|
406
|
+
{
|
|
407
|
+
"$ref": "#/$defs/Templated_string",
|
|
408
|
+
"description": "",
|
|
409
|
+
"examples": [],
|
|
410
|
+
"markdownDescription": ""
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"type": "null"
|
|
414
|
+
}
|
|
415
|
+
],
|
|
416
|
+
"description": "Host header the check sends, for apps that answer only on their own hostname, such as `${{ self.hosts[0] }}`. The request still goes to 127.0.0.1; only the header changes. Defaults to `127.0.0.1:<port>`. Spaces and control characters are refused.",
|
|
417
|
+
"examples": [
|
|
418
|
+
"${{ self.hosts[0] }}",
|
|
419
|
+
"api.example.invalid"
|
|
420
|
+
],
|
|
421
|
+
"markdownDescription": "Host header the check sends, for apps that answer only on their own hostname, such as `${{ self.hosts[0] }}`. The request still goes to 127.0.0.1; only the header changes. Defaults to `127.0.0.1:<port>`. Spaces and control characters are refused."
|
|
422
|
+
},
|
|
404
423
|
"path": {
|
|
405
424
|
"anyOf": [
|
|
406
425
|
{
|
|
@@ -1548,7 +1567,7 @@
|
|
|
1548
1567
|
"type": "null"
|
|
1549
1568
|
}
|
|
1550
1569
|
],
|
|
1551
|
-
"description": "Ready once a GET request to `path` on the unit's main port answers with `status`, or with a 2xx status when `status` is unset. Redirects are not followed. Best when the app has a health route that fails while it is broken.",
|
|
1570
|
+
"description": "Ready once a GET request to `path` on the unit's main port answers with `status`, or with a 2xx status when `status` is unset. Redirects are not followed. Best when the app has a health route that fails while it is broken. Each request sends `User-Agent: devlanes-ready`, so an app can leave the checks out of its request logs.",
|
|
1552
1571
|
"examples": [
|
|
1553
1572
|
{
|
|
1554
1573
|
"path": "/healthz",
|
|
@@ -1556,7 +1575,7 @@
|
|
|
1556
1575
|
"timeout": "60s"
|
|
1557
1576
|
}
|
|
1558
1577
|
],
|
|
1559
|
-
"markdownDescription": "Ready once a GET request to `path` on the unit's main port answers with `status`, or with a 2xx status when `status` is unset. Redirects are not followed. Best when the app has a health route that fails while it is broken."
|
|
1578
|
+
"markdownDescription": "Ready once a GET request to `path` on the unit's main port answers with `status`, or with a 2xx status when `status` is unset. Redirects are not followed. Best when the app has a health route that fails while it is broken. Each request sends `User-Agent: devlanes-ready`, so an app can leave the checks out of its request logs."
|
|
1560
1579
|
},
|
|
1561
1580
|
"log": {
|
|
1562
1581
|
"anyOf": [
|
|
@@ -1869,12 +1888,12 @@
|
|
|
1869
1888
|
"type": "null"
|
|
1870
1889
|
}
|
|
1871
1890
|
],
|
|
1872
|
-
"description": "Set false for an on-demand service: a plain `devlanes start` without a `default` profile skips it, and so do globs such as `*` in profiles. Naming it or its `+tag`, on the command line or in a profile, still starts it. An expression is evaluated for each lane and acts like the `true` or `false` it gives, such as `${{ lane.index == 0 }}` to autostart only in the main lane. With `replicas`, the service starts all its copies when any copy's expression gives true. Defaults to true.",
|
|
1891
|
+
"description": "Set false for an on-demand service: a plain `devlanes start` without a `default` profile skips it unless the lane ran it before, and so do globs such as `*` in profiles. Naming it or its `+tag`, on the command line or in a profile, still starts it. An expression is evaluated for each lane and acts like the `true` or `false` it gives, such as `${{ lane.index == 0 }}` to autostart only in the main lane. With `replicas`, the service starts all its copies when any copy's expression gives true. Defaults to true.",
|
|
1873
1892
|
"examples": [
|
|
1874
1893
|
true,
|
|
1875
1894
|
false
|
|
1876
1895
|
],
|
|
1877
|
-
"markdownDescription": "Set false for an on-demand service: a plain `devlanes start` without a `default` profile skips it, and so do globs such as `*` in profiles. Naming it or its `+tag`, on the command line or in a profile, still starts it. An expression is evaluated for each lane and acts like the `true` or `false` it gives, such as `${{ lane.index == 0 }}` to autostart only in the main lane. With `replicas`, the service starts all its copies when any copy's expression gives true. Defaults to true."
|
|
1896
|
+
"markdownDescription": "Set false for an on-demand service: a plain `devlanes start` without a `default` profile skips it unless the lane ran it before, and so do globs such as `*` in profiles. Naming it or its `+tag`, on the command line or in a profile, still starts it. An expression is evaluated for each lane and acts like the `true` or `false` it gives, such as `${{ lane.index == 0 }}` to autostart only in the main lane. With `replicas`, the service starts all its copies when any copy's expression gives true. Defaults to true."
|
|
1878
1897
|
},
|
|
1879
1898
|
"cwd": {
|
|
1880
1899
|
"anyOf": [
|
|
@@ -1970,6 +1989,25 @@
|
|
|
1970
1989
|
],
|
|
1971
1990
|
"markdownDescription": "Hostnames the devlanes HTTPS proxy routes to this service, so `https://<host>` reaches it. One entry or a list; an entry is a hostname or a mapping with `host` and optional `port` (a named port), `fallback` and `host_header`. A `*.` wildcard matches subdomains, and an exact host wins over it. The first non-wildcard host becomes `public_url`, non-wildcard hosts join the lane's `DEVLANES_ORIGINS`, and having hosts makes the default `ready` a TCP check. Keep them under `${{ lane.domain }}` so lanes do not collide."
|
|
1972
1991
|
},
|
|
1992
|
+
"keep_awake": {
|
|
1993
|
+
"anyOf": [
|
|
1994
|
+
{
|
|
1995
|
+
"$ref": "#/$defs/Templated_boolean",
|
|
1996
|
+
"description": "",
|
|
1997
|
+
"examples": [],
|
|
1998
|
+
"markdownDescription": ""
|
|
1999
|
+
},
|
|
2000
|
+
{
|
|
2001
|
+
"type": "null"
|
|
2002
|
+
}
|
|
2003
|
+
],
|
|
2004
|
+
"description": "While this service runs, devlanes never throttles or freezes its lane, whatever `lanes.throttle_after` and `lanes.freeze_after` in the user config say. Set it on workers, queue consumers, schedulers and tunnels that do work without inbound requests, which a frozen lane would otherwise stall. One such service keeps the whole lane awake. An expression is evaluated for each lane, such as `${{ lane.index == 0 }}` to keep only the main lane awake. Defaults to false.",
|
|
2005
|
+
"examples": [
|
|
2006
|
+
true,
|
|
2007
|
+
false
|
|
2008
|
+
],
|
|
2009
|
+
"markdownDescription": "While this service runs, devlanes never throttles or freezes its lane, whatever `lanes.throttle_after` and `lanes.freeze_after` in the user config say. Set it on workers, queue consumers, schedulers and tunnels that do work without inbound requests, which a frozen lane would otherwise stall. One such service keeps the whole lane awake. An expression is evaluated for each lane, such as `${{ lane.index == 0 }}` to keep only the main lane awake. Defaults to false."
|
|
2010
|
+
},
|
|
1973
2011
|
"name": {
|
|
1974
2012
|
"description": "Label shown in the TUI and human output instead of the service key; any text, spaces allowed, with ` #N` added per replica. Commands, profiles and `${{ services.<key> }}` keep using the key.",
|
|
1975
2013
|
"examples": [
|
|
@@ -3062,7 +3100,7 @@
|
|
|
3062
3100
|
"markdownDescription": "Services started by `devlanes start --profile <name>` (`default` when no profile is given): a list of names, globs and `+tag` selectors, or a mapping that can also exclude services, skip infra, add `env` and remap script names. Several `--profile` flags start the union."
|
|
3063
3101
|
},
|
|
3064
3102
|
"default": {},
|
|
3065
|
-
"description": "Named selections of services for `devlanes start --profile <name
|
|
3103
|
+
"description": "Named selections of services for `devlanes start --profile <name>`. A plain `devlanes start` brings back what the lane ran before; `default` is used when there is nothing to bring back, such as after `devlanes stop`. A profile is a list of names, globs and `+tag` selectors, or a mapping that can also exclude services, skip infra, add `env` and remap script names.",
|
|
3066
3104
|
"examples": [
|
|
3067
3105
|
{
|
|
3068
3106
|
"default": [
|
|
@@ -3079,7 +3117,7 @@
|
|
|
3079
3117
|
}
|
|
3080
3118
|
}
|
|
3081
3119
|
],
|
|
3082
|
-
"markdownDescription": "Named selections of services for `devlanes start --profile <name
|
|
3120
|
+
"markdownDescription": "Named selections of services for `devlanes start --profile <name>`. A plain `devlanes start` brings back what the lane ran before; `default` is used when there is nothing to bring back, such as after `devlanes stop`. A profile is a list of names, globs and `+tag` selectors, or a mapping that can also exclude services, skip infra, add `env` and remap script names.",
|
|
3083
3121
|
"type": "object"
|
|
3084
3122
|
},
|
|
3085
3123
|
"project": {
|
package/user-schema.json
CHANGED
|
@@ -485,6 +485,32 @@
|
|
|
485
485
|
],
|
|
486
486
|
"type": "string"
|
|
487
487
|
},
|
|
488
|
+
"StartConfig": {
|
|
489
|
+
"additionalProperties": false,
|
|
490
|
+
"description": "What a plain `devlanes start`, or `s` on a lane in the TUI, starts. Changes apply to the next command.",
|
|
491
|
+
"examples": [
|
|
492
|
+
{
|
|
493
|
+
"restore": true
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"restore": false
|
|
497
|
+
}
|
|
498
|
+
],
|
|
499
|
+
"markdownDescription": "What a plain `devlanes start`, or `s` on a lane in the TUI, starts. Changes apply to the next command.",
|
|
500
|
+
"properties": {
|
|
501
|
+
"restore": {
|
|
502
|
+
"default": true,
|
|
503
|
+
"description": "Bring back the services the lane ran before, with the same profiles, so a reboot or daemon crash costs one `devlanes start`; defaults to true. A lane stopped as a whole with `devlanes stop` has nothing to bring back and starts its `default` profile. Set false to always start the `default` profile (or every `autostart` service). `lane resume` and `daemon restart` restore either way.",
|
|
504
|
+
"examples": [
|
|
505
|
+
true,
|
|
506
|
+
false
|
|
507
|
+
],
|
|
508
|
+
"markdownDescription": "Bring back the services the lane ran before, with the same profiles, so a reboot or daemon crash costs one `devlanes start`; defaults to true. A lane stopped as a whole with `devlanes stop` has nothing to bring back and starts its `default` profile. Set false to always start the `default` profile (or every `autostart` service). `lane resume` and `daemon restart` restore either way.",
|
|
509
|
+
"type": "boolean"
|
|
510
|
+
}
|
|
511
|
+
},
|
|
512
|
+
"type": "object"
|
|
513
|
+
},
|
|
488
514
|
"StartupConfig": {
|
|
489
515
|
"additionalProperties": false,
|
|
490
516
|
"description": "Pacing of service starts, shared by every lane and project on this machine. Starts queue first come, first served; only spawning waits, running processes are never limited.",
|
|
@@ -1062,13 +1088,21 @@
|
|
|
1062
1088
|
},
|
|
1063
1089
|
"UserLanesConfig": {
|
|
1064
1090
|
"additionalProperties": false,
|
|
1065
|
-
"description": "Machine settings for lanes. Each lane gets its own data folder at `<data_dir>/<project>/<lane id>`, available as `${{ lane.data_path }}` and `DEVLANES_LANE_DATA`. devlanes creates it when the lane is created and before each start, and `devlanes lane clean` deletes it.",
|
|
1091
|
+
"description": "Machine settings for lanes: where their data folders live, and when idle lanes are throttled or frozen. Each lane gets its own data folder at `<data_dir>/<project>/<lane id>`, available as `${{ lane.data_path }}` and `DEVLANES_LANE_DATA`. devlanes creates it when the lane is created and before each start, and `devlanes lane clean` deletes it.",
|
|
1066
1092
|
"examples": [
|
|
1067
1093
|
{
|
|
1068
1094
|
"data_dir": "~/.devlanes/data"
|
|
1095
|
+
},
|
|
1096
|
+
{
|
|
1097
|
+
"freeze_after": "15m",
|
|
1098
|
+
"throttle_after": "5m"
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"freeze_after": "1h",
|
|
1102
|
+
"throttle_after": "0s"
|
|
1069
1103
|
}
|
|
1070
1104
|
],
|
|
1071
|
-
"markdownDescription": "Machine settings for lanes. Each lane gets its own data folder at `<data_dir>/<project>/<lane id>`, available as `${{ lane.data_path }}` and `DEVLANES_LANE_DATA`. devlanes creates it when the lane is created and before each start, and `devlanes lane clean` deletes it.",
|
|
1105
|
+
"markdownDescription": "Machine settings for lanes: where their data folders live, and when idle lanes are throttled or frozen. Each lane gets its own data folder at `<data_dir>/<project>/<lane id>`, available as `${{ lane.data_path }}` and `DEVLANES_LANE_DATA`. devlanes creates it when the lane is created and before each start, and `devlanes lane clean` deletes it.",
|
|
1072
1106
|
"properties": {
|
|
1073
1107
|
"data_dir": {
|
|
1074
1108
|
"default": null,
|
|
@@ -1082,6 +1116,27 @@
|
|
|
1082
1116
|
"string",
|
|
1083
1117
|
"null"
|
|
1084
1118
|
]
|
|
1119
|
+
},
|
|
1120
|
+
"freeze_after": {
|
|
1121
|
+
"$ref": "#/$defs/ConfigDuration",
|
|
1122
|
+
"default": "900000ms",
|
|
1123
|
+
"description": "After this long without activity, devlanes freezes a lane: it suspends every process of the lane and pauses the lane's own containers. Shared infra is never paused. Ports and process state are kept, so a frozen lane still counts as running. Activity is a request through the proxy, a new connection to one of the lane's ports, the lane's services using CPU, or a devlanes command on the lane; any of it resumes a frozen lane and restarts the timer. A request through the proxy resumes the lane at once and then goes through; a direct connection to a port is noticed within about half a second. When both are set above `0s`, it must be longer than `throttle_after` (`5m` unless set). A running service with `services.<name>.keep_awake: true` keeps its whole lane awake. Defaults to `15m`; `0s` turns freezing off. The daemon reads it when it starts.",
|
|
1124
|
+
"examples": [
|
|
1125
|
+
"15m",
|
|
1126
|
+
"1h",
|
|
1127
|
+
"0s"
|
|
1128
|
+
],
|
|
1129
|
+
"markdownDescription": "After this long without activity, devlanes freezes a lane: it suspends every process of the lane and pauses the lane's own containers. Shared infra is never paused. Ports and process state are kept, so a frozen lane still counts as running. Activity is a request through the proxy, a new connection to one of the lane's ports, the lane's services using CPU, or a devlanes command on the lane; any of it resumes a frozen lane and restarts the timer. A request through the proxy resumes the lane at once and then goes through; a direct connection to a port is noticed within about half a second. When both are set above `0s`, it must be longer than `throttle_after` (`5m` unless set). A running service with `services.<name>.keep_awake: true` keeps its whole lane awake. Defaults to `15m`; `0s` turns freezing off. The daemon reads it when it starts."
|
|
1130
|
+
},
|
|
1131
|
+
"throttle_after": {
|
|
1132
|
+
"$ref": "#/$defs/ConfigDuration",
|
|
1133
|
+
"default": "300000ms",
|
|
1134
|
+
"description": "After this long without activity, a lane's processes run at background priority: lower CPU priority, and efficiency cores on machines that have them. They keep serving requests. Activity is a request through the proxy, a new connection to one of the lane's ports, the lane's services using CPU, or a devlanes command on the lane; any of it restores normal priority and restarts the timer. macOS and Windows only; Linux has no throttling, so lanes there stay at normal priority until `freeze_after`. When both are set above `0s`, it must be shorter than `freeze_after`. A running service with `services.<name>.keep_awake: true` keeps its whole lane at normal priority. Defaults to `5m`; `0s` turns throttling off. The daemon reads it when it starts.",
|
|
1135
|
+
"examples": [
|
|
1136
|
+
"5m",
|
|
1137
|
+
"0s"
|
|
1138
|
+
],
|
|
1139
|
+
"markdownDescription": "After this long without activity, a lane's processes run at background priority: lower CPU priority, and efficiency cores on machines that have them. They keep serving requests. Activity is a request through the proxy, a new connection to one of the lane's ports, the lane's services using CPU, or a devlanes command on the lane; any of it restores normal priority and restarts the timer. macOS and Windows only; Linux has no throttling, so lanes there stay at normal priority until `freeze_after`. When both are set above `0s`, it must be shorter than `freeze_after`. A running service with `services.<name>.keep_awake: true` keeps its whole lane at normal priority. Defaults to `5m`; `0s` turns throttling off. The daemon reads it when it starts."
|
|
1085
1140
|
}
|
|
1086
1141
|
},
|
|
1087
1142
|
"type": "object"
|
|
@@ -1159,15 +1214,25 @@
|
|
|
1159
1214
|
"lanes": {
|
|
1160
1215
|
"$ref": "#/$defs/UserLanesConfig",
|
|
1161
1216
|
"default": {
|
|
1162
|
-
"data_dir": null
|
|
1217
|
+
"data_dir": null,
|
|
1218
|
+
"freeze_after": "900000ms",
|
|
1219
|
+
"throttle_after": "300000ms"
|
|
1163
1220
|
},
|
|
1164
|
-
"description": "Where lane data folders (`lane.data_path`) live on this machine.",
|
|
1221
|
+
"description": "Where lane data folders (`lane.data_path`) live on this machine, and how long a lane may sit without activity before devlanes throttles or freezes it.",
|
|
1165
1222
|
"examples": [
|
|
1166
1223
|
{
|
|
1167
1224
|
"data_dir": "~/.devlanes/data"
|
|
1225
|
+
},
|
|
1226
|
+
{
|
|
1227
|
+
"freeze_after": "15m",
|
|
1228
|
+
"throttle_after": "5m"
|
|
1229
|
+
},
|
|
1230
|
+
{
|
|
1231
|
+
"freeze_after": "1h",
|
|
1232
|
+
"throttle_after": "0s"
|
|
1168
1233
|
}
|
|
1169
1234
|
],
|
|
1170
|
-
"markdownDescription": "Where lane data folders (`lane.data_path`) live on this machine."
|
|
1235
|
+
"markdownDescription": "Where lane data folders (`lane.data_path`) live on this machine, and how long a lane may sit without activity before devlanes throttles or freezes it."
|
|
1171
1236
|
},
|
|
1172
1237
|
"logs": {
|
|
1173
1238
|
"$ref": "#/$defs/LogsConfig",
|
|
@@ -1233,6 +1298,22 @@
|
|
|
1233
1298
|
],
|
|
1234
1299
|
"markdownDescription": "Ports of the daemon's HTTP/HTTPS proxy, which serves every `hosts` entry, and whether other devices on the network may connect to it."
|
|
1235
1300
|
},
|
|
1301
|
+
"start": {
|
|
1302
|
+
"$ref": "#/$defs/StartConfig",
|
|
1303
|
+
"default": {
|
|
1304
|
+
"restore": true
|
|
1305
|
+
},
|
|
1306
|
+
"description": "What a plain `devlanes start` (no services, no `--profile`) brings up: the services the lane ran before, or its default selection.",
|
|
1307
|
+
"examples": [
|
|
1308
|
+
{
|
|
1309
|
+
"restore": true
|
|
1310
|
+
},
|
|
1311
|
+
{
|
|
1312
|
+
"restore": false
|
|
1313
|
+
}
|
|
1314
|
+
],
|
|
1315
|
+
"markdownDescription": "What a plain `devlanes start` (no services, no `--profile`) brings up: the services the lane ran before, or its default selection."
|
|
1316
|
+
},
|
|
1236
1317
|
"startup": {
|
|
1237
1318
|
"$ref": "#/$defs/StartupConfig",
|
|
1238
1319
|
"default": {
|