Skip to content

Commit bf3aa20

Browse files
authored
Merge pull request #2312 from loft-sh/docs-hide-deprecated
docs: hide deprecated printLogs & remoteExec configs in docs
2 parents 97fca63 + 54d6518 commit bf3aa20

10 files changed

Lines changed: 8 additions & 60 deletions

File tree

devspace-schema.json

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1698,10 +1698,6 @@
16981698
"file": {
16991699
"type": "boolean",
17001700
"description": "File signals DevSpace that this is a single file that should get synced instead of a whole directory"
1701-
},
1702-
"printLogs": {
1703-
"type": "boolean",
1704-
"description": "PrintLogs defines if sync logs should be displayed on the terminal"
17051701
}
17061702
},
17071703
"type": "object",
@@ -1790,7 +1786,7 @@
17901786
},
17911787
"execRemote": {
17921788
"$ref": "#/$defs/SyncExecCommand",
1793-
"description": "Defines what commands should be executed on the container side if a change is uploaded and applied in the target\ncontainer"
1789+
"description": "Defines what commands should be executed on the container side if a change is uploaded and applied in the target\ncontainer. Deprecated, use `Exec`."
17941790
}
17951791
},
17961792
"type": "object",

docs/pages/configuration/_partials/v2beta1/deployments/updateImageTags.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<details className="config-field" data-expandable="false" open>
33
<summary>
44

5-
### `updateImageTags` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">true</span> <span className="config-field-enum"></span> {#deployments-updateImageTags}
5+
### `updateImageTags` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">false</span> <span className="config-field-enum"></span> {#deployments-updateImageTags}
66

77
UpdateImageTags lets you define if DevSpace should update the tags of the images defined in the
88
images section with their most recent built tag.

docs/pages/configuration/_partials/v2beta1/dev/containers/sync/onUpload/execRemote.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import PartialExecRemotereference from "./execRemote_reference.mdx"
88
###### `execRemote` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-sync-onUpload-execRemote}
99

1010
Defines what commands should be executed on the container side if a change is uploaded and applied in the target
11-
container
11+
container. Deprecated, use `Exec`.
1212

1313
</summary>
1414

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11

22
import PartialRestartContainer from "./onUpload/restartContainer.mdx"
33
import PartialExecreference from "./onUpload/exec_reference.mdx"
4-
import PartialExecRemotereference from "./onUpload/execRemote_reference.mdx"
54

65
<PartialRestartContainer />
76

@@ -20,20 +19,3 @@ Exec will execute the given commands in order after a sync operation
2019

2120

2221
</details>
23-
24-
25-
26-
<details className="config-field" data-expandable="true">
27-
<summary>
28-
29-
###### `execRemote` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-sync-onUpload-execRemote}
30-
31-
Defines what commands should be executed on the container side if a change is uploaded and applied in the target
32-
container
33-
34-
</summary>
35-
36-
<PartialExecRemotereference />
37-
38-
39-
</details>

docs/pages/configuration/_partials/v2beta1/dev/containers/sync_reference.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import PartialBandwidthLimitsreference from "./sync/bandwidthLimits_reference.md
88
import PartialPolling from "./sync/polling.mdx"
99
import PartialNoWatch from "./sync/noWatch.mdx"
1010
import PartialFile from "./sync/file.mdx"
11-
import PartialPrintLogs from "./sync/printLogs.mdx"
1211

1312
<PartialPath />
1413

@@ -49,6 +48,3 @@ sync configuration
4948

5049

5150
<PartialFile />
52-
53-
54-
<PartialPrintLogs />

docs/pages/configuration/_partials/v2beta1/dev/sync/onUpload/execRemote.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import PartialExecRemotereference from "./execRemote_reference.mdx"
88
##### `execRemote` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-sync-onUpload-execRemote}
99

1010
Defines what commands should be executed on the container side if a change is uploaded and applied in the target
11-
container
11+
container. Deprecated, use `Exec`.
1212

1313
</summary>
1414

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11

22
import PartialRestartContainer from "./onUpload/restartContainer.mdx"
33
import PartialExecreference from "./onUpload/exec_reference.mdx"
4-
import PartialExecRemotereference from "./onUpload/execRemote_reference.mdx"
54

65
<PartialRestartContainer />
76

@@ -20,20 +19,3 @@ Exec will execute the given commands in order after a sync operation
2019

2120

2221
</details>
23-
24-
25-
26-
<details className="config-field" data-expandable="true">
27-
<summary>
28-
29-
##### `execRemote` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-sync-onUpload-execRemote}
30-
31-
Defines what commands should be executed on the container side if a change is uploaded and applied in the target
32-
container
33-
34-
</summary>
35-
36-
<PartialExecRemotereference />
37-
38-
39-
</details>

docs/pages/configuration/_partials/v2beta1/dev/sync_reference.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import PartialBandwidthLimitsreference from "./sync/bandwidthLimits_reference.md
88
import PartialPolling from "./sync/polling.mdx"
99
import PartialNoWatch from "./sync/noWatch.mdx"
1010
import PartialFile from "./sync/file.mdx"
11-
import PartialPrintLogs from "./sync/printLogs.mdx"
1211

1312
<PartialPath />
1413

@@ -49,6 +48,3 @@ sync configuration
4948

5049

5150
<PartialFile />
52-
53-
54-
<PartialPrintLogs />

docs/schemas/config-openapi.json

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1706,10 +1706,6 @@
17061706
"file": {
17071707
"type": "boolean",
17081708
"description": "File signals DevSpace that this is a single file that should get synced instead of a whole directory"
1709-
},
1710-
"printLogs": {
1711-
"type": "boolean",
1712-
"description": "PrintLogs defines if sync logs should be displayed on the terminal"
17131709
}
17141710
},
17151711
"type": "object",
@@ -1798,7 +1794,7 @@
17981794
},
17991795
"execRemote": {
18001796
"$ref": "#/definitions/Config/$defs/SyncExecCommand",
1801-
"description": "Defines what commands should be executed on the container side if a change is uploaded and applied in the target\ncontainer"
1797+
"description": "Defines what commands should be executed on the container side if a change is uploaded and applied in the target\ncontainer. Deprecated, use `Exec`."
18021798
}
18031799
},
18041800
"type": "object",

pkg/devspace/config/versions/latest/schema.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1104,7 +1104,7 @@ type SyncConfig struct {
11041104
File bool `yaml:"file,omitempty" json:"file,omitempty"`
11051105

11061106
// PrintLogs defines if sync logs should be displayed on the terminal
1107-
PrintLogs bool `yaml:"printLogs,omitempty" json:"printLogs,omitempty"`
1107+
PrintLogs bool `yaml:"printLogs,omitempty" json:"printLogs,omitempty" jsonschema:"-"`
11081108
}
11091109

11101110
type ContainerArchitecture string
@@ -1125,8 +1125,8 @@ type SyncOnUpload struct {
11251125
Exec []SyncExec `yaml:"exec,omitempty" json:"exec,omitempty"`
11261126

11271127
// Defines what commands should be executed on the container side if a change is uploaded and applied in the target
1128-
// container
1129-
ExecRemote *SyncExecCommand `yaml:"execRemote,omitempty" json:"execRemote,omitempty"`
1128+
// container. Deprecated, use `Exec`.
1129+
ExecRemote *SyncExecCommand `yaml:"execRemote,omitempty" json:"execRemote,omitempty" jsonschema:"-"`
11301130
}
11311131

11321132
type SyncExec struct {

0 commit comments

Comments
 (0)