feat: add squash_merge_commit_title, squash_merge_commit_message,…

… `merge_commit_title` and `merge_commit_message` attributes when creating, updating and reading repositories (#227) WIP
octokit · Aug 19, 2022 · 18a8faa · 18a8faa
1 parent 0c58c73
commit 18a8faa
Show file tree

Hide file tree

Showing 21 changed files with 2,424 additions and 98 deletions.
diff --git a/cache/api.github.com.json b/cache/api.github.com.json
diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json
@@ -1,7 +1,7 @@
 {
  "openapi": "3.0.3",
  "info": {
- "version": "7.3.0",
+ "version": "7.4.0",
  "title": "GitHub's official OpenAPI spec + Octokit extension",
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
  "license": {
@@ -13897,6 +13897,40 @@
  "type": "boolean",
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
  "default": false
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
  }
  },
  "required": [
@@ -18278,6 +18312,40 @@
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
  "default": false
  },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
  "archived": {
  "type": "boolean",
  "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -19598,9 +19666,12 @@
  "content": {
  "application/json": {
  "schema": {
- "type": "object",
- "properties": {},
- "additionalProperties": false
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
  }
  }
  }
@@ -19911,6 +19982,17 @@
  "state",
  "comment"
  ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "environment_ids": [
+ 161171787
+ ],
+ "state": "approved",
+ "comment": "Ship it!"
+ }
+ }
  }
  }
  }
@@ -19974,6 +20056,11 @@
  "schema": {
  "type": "object",
  "nullable": true
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
  }
  }
  }
@@ -19984,9 +20071,12 @@
  "content": {
  "application/json": {
  "schema": {
- "type": "object",
- "properties": {},
- "additionalProperties": false
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
  }
  }
  }
@@ -20224,9 +20314,12 @@
  "content": {
  "application/json": {
  "schema": {
- "type": "object",
- "properties": {},
- "additionalProperties": false
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
  }
  }
  }
@@ -47756,6 +47849,40 @@
  "type": "boolean",
  "example": false
  },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
  "has_downloads": {
  "description": "Whether downloads are enabled.",
  "default": true,