Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecation note to github node in .gitpod.yml – EXP-682 #18788

Merged
merged 1 commit into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions components/gitpod-protocol/data/gitpod-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -178,34 +178,41 @@
},
"github": {
"type": "object",
"description": "Configures Gitpod's GitHub app",
"description": "Configures Gitpod's GitHub app (deprecated)",
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds.",
"properties": {
"prebuilds": {
"type": [
"boolean",
"object"
],
"description": "Set to true to enable workspace prebuilds, false to disable them. Defaults to true.",
"description": "Set to true to enable workspace prebuilds, false to disable them. Defaults to true. (deprecated)",
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds.",
"properties": {
"master": {
"type": "boolean",
"description": "Enable prebuilds for the default branch (typically master). Defaults to true."
"description": "Enable prebuilds for the default branch (typically master). Defaults to true.",
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds."
},
"branches": {
"type": "boolean",
"description": "Enable prebuilds for all branches. Defaults to false."
"description": "Enable prebuilds for all branches. Defaults to false.",
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds."
},
"pullRequests": {
"type": "boolean",
"description": "Enable prebuilds for pull-requests from the original repo. Defaults to true."
"description": "Enable prebuilds for pull-requests from the original repo. Defaults to true.",
"deprecationMessage": "Deprecated. Please use the Project Settings to configure prebuilds."
},
"pullRequestsFromForks": {
"type": "boolean",
"description": "Enable prebuilds for pull-requests from any repo (e.g. from forks). Defaults to false."
"description": "Enable prebuilds for pull-requests from any repo (e.g. from forks). Defaults to false.",
"deprecationMessage": "Deprecated. This feature is about to be removed."
},
"addBadge": {
"type": "boolean",
"description": "Add a Review in Gitpod badge to pull requests. Defaults to true."
"description": "Add a Review in Gitpod badge to pull requests. Defaults to true.",
"deprecationMessage": "Deprecated. This feature is about to be removed."
},
"addCheck": {
"type": [
Expand All @@ -217,14 +224,16 @@
false,
"prevent-merge-on-error"
],
"description": "Add a commit check to pull requests. Set to 'fail-on-error' if you want broken prebuilds to block merging. Defaults to true."
"description": "Add a commit check to pull requests. Set to 'fail-on-error' if you want broken prebuilds to block merging. Defaults to true.",
"deprecationMessage": "Deprecated. This feature is about to be removed."
},
"addLabel": {
"type": [
"boolean",
"string"
],
"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."
"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.",
"deprecationMessage": "Deprecated. This feature is about to be removed."
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions components/gitpod-protocol/go/gitpod-config-types.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.