v8.0.0

8.0.0 (2022-09-22)

BREAKING CHANGES

• Any API operations only available to GitHub Enterprise Cloud (GHEC) customers will no longer appear in the api.github.com OpenAPI specifications. These will only appear in a new GHEC-specific (ghec) OpenAPI specifications.

Other changes

• feat: add new "Get a Dependabot alert" API (GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number})
• feat: add new "Update a Dependabot alert" API (PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number})
• feat: add new "List Dependabot alerts for a repository" API (GET /repos/{owner}/{repo}/dependabot/alerts)
• fix: document 404 Not Found status returned by labels-related APIs
• fix: mark recently-added "List CodeQL databases for a repository" API (GET /repos/{owner}/{repo}/code-scanning/codeql/databases) and Get a CodeQL database for a repository" API (GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}) as available for non-GitHub Enterprise Cloud customers
• fix: document that APIs can return 422 errors when an endpoint has been spammed with many requests
• fix: document 301 status returned by labels-related APIs if the repo has been renamed or moved
• fix: document that "Delete a GitHub Pages site" (DELETE /repos/{owner}/{repo}/pages) and "Update information about a GitHub Pages site" (PUT /repos/{owner}/{repo}/pages) APIs return 409 if the repo is archived

v7.14.0

7.14.0 (2022-09-16)

Features

• add new display_title attribute returned on workflow runs in the API (e.g. in GET /repos/{owner}/{repo}/actions/runs) (#295) (c3e6e0e)

v7.13.0

7.13.0 (2022-09-15)

• feat: add new "List CodeQL databases for a repository" API (GET /repos/{owner}/{repo}/code-scanning/codeql/databases)
• feat: add new "Get a CodeQL database for a repository" API (GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language})
• fix: update descriptions for "Create or update file contents" (PUT /repos/{owner}/{repo}/contents/{path}) and "Delete a file" (DELETE /repos/{owner}/{repo}/contents/{path}) APIs to clarify that calling them in parallel may lead to conflicts
• fix: correct casing of github advanced security to GitHub Advanced Security in descriptions

v7.12.1

7.12.1 (2022-09-14)

Bug Fixes

• Update description for the "Update a secret scanning alert" API (PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}) to clarify that a resolution must be provided when setting state to resolved
• Update a number of APIs to use enums to describe allowed values, rather than string types with a list of values in the description (e.g. the conclusion attribute returned in the "Get a job for a workflow run" API [GET /repos/{owner}/{repo}/actions/jobs/{job_id}])

v7.12.0

7.12.0 (2022-09-13)

• feat: add new github_com_enterprise_roles response attribute to the "List enterprise consumed licenses" API (GET /enterprises/{enterprise}/consumed-licenses), marking the old singular github_com_enterprise_role attribute as deprecated
• feat: allow the "List repository collaborators" API (GET /repos/{owner}/{repo}/collaborators) to be filtered by permission using a query param
• fix: mark the "List enterprise consumed licenses" API (GET /enterprises/{enterprise}/consumed-licenses) as beta
• fix: clarify in the description that the "Get or update file contents" API (PUT /repos/{owner}/{repo}/contents/{path}) requires the workflow scope
• fix: adding missing description for the "List repository webhooks" API (GET /repos/{owner}/{repo}/hooks)

v7.11.0

7.11.0 (2022-09-09)

• feat: allow key pattern for the "Create a SSH signing key for the authenticated user" API (POST /user/ssh_signing_keys) to allow physical security keys
• fix: tweak description for "Get a tree" API (GET /repos/{owner}/{repo}/git/trees/{tree_sha}) to clarify maximum limits on size and number of entries
• fix: mark the path parameter for the base and head branch to compare in the "Compare two commits" API (GET repos/{owner}/{repo}/compare/{basehead}) as multi-segment
• fix: document allowed response statuses for the "Update a team" API (PATCH /orgs/{org}/teams/{team_slug})

v7.10.0

7.10.0 (2022-09-07)

• Add new public beta APIs for creating, reading, updating and deleting custom repo roles (POST /orgs/{org}/custom_roles, PATCH /orgs/{org}/custom_roles/{role_id}, DELETE /orgs/{org}/custom_roles/{role_id}, GET /orgs/{org}/fine_grained_permissions)
• Add new description, base_role, permissions, organization, created_at and updated_attributes where custom repo roles are returned in the API
• Rename APIs for listing package versions (e.g. GET /orgs/{org}/packages/{package_type}/{package_name}/versions) to clarify that they returned paginated lists ("Get all..." -> "List...")
• Mark use_squash_pr_title_as_default attribute on repos as deprecated in favour of squash_merge_commit_title
• Rename "List workflow runs" (GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs) API to the more indicative "List workflow runs for a workflow"
• Correct description of sha request body parameter in the "Delete a file" API (DELETE /repos/{owner}/{repo}/contents/{path})

v7.9.1

7.9.1 (2022-09-06)

Bug Fixes

• update examples for Codespace machines in an API response (#287) (a0958e3)

v7.9.0

7.9.0 (2022-09-05)

• allow filtering "List workflows runs for a repository" (GET /repos/{owner}/{repo}/actions/runs) and "List workflow runs [for a workflow]" (GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs ) by head_sha
• tweak the recently-added state_reason attribute on issues to be a enum (completed, not_planned or reopened) rather than an unbounded string

v7.8.0

7.8.0 (2022-09-02)

Features

• add is_alphanumeric boolean attribute, accepted in the request body of the "Create an autolink reference for a repository" (POST /repos/{owner}/{repo}/autolinks) API and returned on autolinks across the API
• add rule.help_uri attribute returned on code scanning alerts across the API (GET /enterprises/{enterprise}/code-scanning/alerts, GET /orgs/{org}/code-scanning/alerts, GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}, PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number})
• tweak documentation for "Create an autolink reference for a repository" (POST /repos/{owner}/{repo}/autolinks)
• clarify in documentation that the "Create a repository using a template" (POST /repos/{template_owner}/{template_repo}/generate) doesn't require special permissions with a public repo
• document long-standing anonymous_access_enabled boolean attribute returned on repos in the API
• add 503 as a potential response status code across various API operations
• drop 302 as a potential response status code for GET /orgs/{org}/members, which hasn't been returned for nearly 8 years