Skip to content

Commit d897a6c

Browse files
authored
Add deprecation note to github node in .gitpod.yml (#18788)
1 parent 1325935 commit d897a6c

File tree

2 files changed

+22
-13
lines changed

2 files changed

+22
-13
lines changed

components/gitpod-protocol/data/gitpod-schema.json

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -178,34 +178,41 @@
178178
},
179179
"github": {
180180
"type": "object",
181-
"description": "Configures Gitpod's GitHub app",
181+
"description": "Configures Gitpod's GitHub app (deprecated)",
182+
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds.",
182183
"properties": {
183184
"prebuilds": {
184185
"type": [
185186
"boolean",
186187
"object"
187188
],
188-
"description": "Set to true to enable workspace prebuilds, false to disable them. Defaults to true.",
189+
"description": "Set to true to enable workspace prebuilds, false to disable them. Defaults to true. (deprecated)",
190+
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds.",
189191
"properties": {
190192
"master": {
191193
"type": "boolean",
192-
"description": "Enable prebuilds for the default branch (typically master). Defaults to true."
194+
"description": "Enable prebuilds for the default branch (typically master). Defaults to true.",
195+
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds."
193196
},
194197
"branches": {
195198
"type": "boolean",
196-
"description": "Enable prebuilds for all branches. Defaults to false."
199+
"description": "Enable prebuilds for all branches. Defaults to false.",
200+
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds."
197201
},
198202
"pullRequests": {
199203
"type": "boolean",
200-
"description": "Enable prebuilds for pull-requests from the original repo. Defaults to true."
204+
"description": "Enable prebuilds for pull-requests from the original repo. Defaults to true.",
205+
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds."
201206
},
202207
"pullRequestsFromForks": {
203208
"type": "boolean",
204-
"description": "Enable prebuilds for pull-requests from any repo (e.g. from forks). Defaults to false."
209+
"description": "Enable prebuilds for pull-requests from any repo (e.g. from forks). Defaults to false.",
210+
"deprecationMessage": "Deprecated. This feature is about to be removed."
205211
},
206212
"addBadge": {
207213
"type": "boolean",
208-
"description": "Add a Review in Gitpod badge to pull requests. Defaults to true."
214+
"description": "Add a Review in Gitpod badge to pull requests. Defaults to true.",
215+
"deprecationMessage": "Deprecated. This feature is about to be removed."
209216
},
210217
"addCheck": {
211218
"type": [
@@ -217,14 +224,16 @@
217224
false,
218225
"prevent-merge-on-error"
219226
],
220-
"description": "Add a commit check to pull requests. Set to 'fail-on-error' if you want broken prebuilds to block merging. Defaults to true."
227+
"description": "Add a commit check to pull requests. Set to 'fail-on-error' if you want broken prebuilds to block merging. Defaults to true.",
228+
"deprecationMessage": "Deprecated. This feature is about to be removed."
221229
},
222230
"addLabel": {
223231
"type": [
224232
"boolean",
225233
"string"
226234
],
227-
"description": "Add a label to a PR when it's prebuilt. Set to true to use the default label (prebuilt-in-gitpod) or set to a string to use a different label name. This is a beta feature and may be unreliable. Defaults to false."
235+
"description": "Add a label to a PR when it's prebuilt. Set to true to use the default label (prebuilt-in-gitpod) or set to a string to use a different label name. This is a beta feature and may be unreliable. Defaults to false.",
236+
"deprecationMessage": "Deprecated. This feature is about to be removed."
228237
}
229238
}
230239
}

components/gitpod-protocol/go/gitpod-config-types.go

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)