1
0
mirror of synced 2026-02-03 00:02:00 -05:00

GitHub Enterprise Server 3.12 release candidate (#48810)

Co-authored-by: David Jarzebowski <davidjarzebowski@github.com>
Co-authored-by: isaacmbrown <isaacmbrown@github.com>
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com>
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
This commit is contained in:
Matt Pollard
2024-02-15 01:02:13 +01:00
committed by GitHub
parent 53e327b197
commit 4ba475abbf
45 changed files with 922222 additions and 64 deletions

View File

@@ -0,0 +1,199 @@
Category,Old Attribute,New Attribute
Aqueduct,kube_cluster,k8s.cluster.name
Aqueduct,kube_app,k8s.app.name
Aqueduct,kube_pod_namespace,k8s.pod.namespace
Aqueduct,kube_pod,k8s.pod.name
Aqueduct,kube_pod_ip,k8s.pod.ip
Aqueduct,current_ref,aqueduct.ref
Aqueduct,cluster,aqueduct.cluster.name
Aqueduct Bridge,current_ref,aqueduct-bridge.ref
Pull Requests,pull,gh.pull_request.id
Pull Requests,pull_valid,gh.pull_request.valid
Pull Requests,pull_saved,gh.pull_request.saved
Pull Requests,pull_errors,gh.pull_request.errors
Pull Requests,issue_valid,gh.issue.valid
Pull Requests,issue_saved,gh.issue.saved
Pull Requests,issue_errors,gh.issue.errors
Viewscreen,action,gh.viewscreen.action
Viewscreen,format,gh.viewscreen.format
gitcoin/billing,business_id,gh.business.id
gitcoin/billing,failed_event,code.namespace
gitcoin/billing,job,gh.job.name
gitcoin/billing,customer_id,gh.customer.id
gitcoin/billing,product,gh.product.name
gitcoin/billing,legacy,gh.billing.legacy.status
gitcoin/billing,purpose,gh.billing.synchronization.purpose
gitcoin/billing,user_id,gh.user.id
gitcoin/billing,plan_name,gh.plan.name
gitcoin/billing,attempts_per_exception,gh.job.attempt.count
gitcoin/billing,account_id,gh.billing.zuora_account.id
gitcoin/billing,owner_id,gh.user.id
gitcoin/billing,asset_status_id,gh.asset_status.id
gitcoin/billing,user,gh.user.id
gitcoin/billing,billing_transaction_id,gh.billing.transaction.id
gitcoin/billing,twirp_error_code,http.status.code
gitcoin/billing,name,http.method
gitcoin/billing,user,gh.target.id
gitcoin/billing,business,gh.business.id
gitcoin/billing,results,gh.billing.plan_subscription.synchronization.results
gitcoin/billing,zuora_account_id,gh.billing.zuora_account.id
gitcoin/billing,message,gh.billing.result.error_message
gitcoin/billing,message,gh.billing.zuora.result.error_message
gitcoin/billing,name,code.function
gitcoin/billing,stripe_transfer_id,gh.billing.stripe_transfer.id
gitcoin/billing,account_id,gh.account.id
gitcoin/billing,account_type,gh.account.type
gitcoin/billing,subscription_item_id,gh.billing.subscription_item.id
gitcoin/billing,target ,gh.target.id
gitcoin/billing,processor,code.namespace
gitcoin/billing,zuora_invoice_id,gh.billing.zuora_invoice.id
gitcoin/billing,zuora_error_result,gh.billing.zuora.result
gitcoin/billing,invoice_id,gh.billing.zuora.invoice.id
gitcoin/billing,adjustment_amount,gh.billing.zuora.invoice_adjustment.amount
gitcoin/billing,adjustments ,gh.billing.zuora.adjustments
gitcoin/billing,message,gh.billing.braintree.response.message
gitcoin/billing,gh.user.login,gh.user.id
gitcoin/billing,gh.billing.billable_entity.name,gh.billing.billable_entity.id
notebooks,repository_id,gh.repo.id
notebooks,commit,gh.git.sha
notebooks,browser,browser.brands
notebooks,version,browser.brands
notebooks,kube_cluster_name,k8s.cluster.name
notebooks,path,url.path
notebooks,is_iframe,gh.notebooks.is_iframe
notebooks,source,gh.notebooks.error.source
notebooks,repository_type,gh.notebooks.repo_type
notebooks,view_type,gh.notebooks.view_type
notebooks,LFS,gh.notebooks.LFS
notebooks,bypass_fastly,gh.notebooks.bypass_fastly
notebooks,fastly-cache-hit,gh.notebooks.fastly_cache_hit
notebooks,codeload_response,gh.notebooks.codeload.response
notebooks,codeload_status_code,gh.notebooks.codeload.status
notebooks,language,gh.notebooks.notebook.language
notebooks,visibility,gh.notebooks.notebook.visibility
notebooks,file_size,gh.notebooks.notebook.size
notebooks,notebook_version,gh.notebooks.notebook.version
Pull Requests,method,gh.pull_request.merge_method
Pull Requests,head_oid,gh.pull_request.head_oid
Pull Requests,base_oid,gh.pull_request.base_oid
Pull Requests,root_oid,gh.pull_request.root_oid
Pull Requests,comment_id,gh.comment.id
Pull Requests,user_id,gh.owner.id
Pull Requests,force_pushed,gh.pull_request.force_pushed
Pull Requests,pusher,gh.pull_request.pusher.id
Pull Requests,ref_name,gh.merge_queue.ref_name_suffix
Pull Requests,ref_sha,gh.merge_queue.ref_sha
Pull Requests,gh.merge_queue.branch,gh.merge_queue.id
Pull Requests,queue_id,gh.merge_queue.id
Pull Requests,record_errors,gh.merge_queue.record_errors
Pull Requests,new_head_ref,gh.pull_request.new_head_ref
Pull Requests,job_id,gh.pull_request.job.id
Pull Requests,spec,gh.repo.dgit_spec
Pull Requests,thread,gh.pull_request_review_thread.id
Pull Requests,reason_code,gh.pull_request.reason_code
Pull Requests,auto_merge_request_id,gh.auto_merge_request.id
Pull Requests,solo,gh.auto_merge_request.solo
Pull Requests,jump_queue,gh.auto_merge_request.jump_queue
Pull Requests,head_repo_id,gh.pull_request.head_repo.id
Pull Requests,branch,gh.merge_queue.branch
Pull Requests,guid,gh.pull_request.guid
Pull Requests,fn,"code.namespace,code.function"
Pull Requests,organization,gh.organization
Pull Requests,result,gh.merge_queue.result
Pull Requests,feature_flag,gh.merge_queue.feature_flag
Pull Requests,plan_support,gh.merge_queue.plan_support
Pull Requests,github_owned,gh.merge_queue.github_owned
Pull Requests,direct_compare,gh.pull_request.comparison.direct
Pull Requests,head_ref_valid,gh.pull_request.head_ref.valid
Pull Requests,comparison_viewable,gh.pull_request.comparison.viewable
Pull Requests,comparison_valid,gh.pull_request.comparison.valid
Pull Requests,pull_valid,gh.pull_request.valid
Pull Requests,pull_saved,gh.pull_request.saved
Pull Requests,pull_errors,gh.pull_request.errors
API,accept,http.request.header.accept
API,api_route,http.route
API,auth_fingerprint,gh.auth.fingerprint
API,auth,gh.auth.type
API,connections,gh.db.connection_map
API,content_authorization_failure,gh.auth.failure.name
API,controller,code.namespace
API,critical,gh.exception.is_critical
API,current_user,gh.actor.id
API,granted_oauth_scopes,enduser.scope
API,graphql_current_field,gh.graphql.current_field
API,graphql_current_path,gh.graphql.current_path
API,graphql_global_id_type,gh.graphql.global_id_type
API,graphql_query_hash,gh.graphql.query_hash
API,graphql_schema_target,gh.graphql.schema_target
API,graphql_variables_hash,gh.graphql.variables_hash
API,graphql,gh.request.is_graphql
API,installation_id,gh.integration_installation.id
API,integration_id,gh.integration.id
API,integration,gh.integration.id
API,is_employee,gh.user.is_employee
API,is_protected_by_hmac,gh.api.is_protected_by_hmac
API,language,http.request.header.accept_language
API,limited_index,gh.rate_limit.secondary.search_index
API,limited_key,gh.rate_limit.secondary.key
API,limited_limit,gh.rate_limit.secondary.max
API,limited_ttl,gh.rate_limit.secondary.ttl
API,limited,gh.rate_limit.secondary.limit_reason
API,master_pid,process.parent_pid
API,master_started_at,gh.process.parent.started_at
API,method,http.method
API,oauth_access_id,gh.oauth.access.id
API,oauth_app,gh.oauth.app.id
API,oauth_application_id,gh.oauth.app.id
API,oauth_party,gh.oauth.app.party_type
API,oauth_scopes,enduser.scope
API,operation_name,graphql.operation.name
API,org,gh.organization.login
API,origin,gh.graphql.origin
API,params,http.request.parameters.*
API,parent_installation_id,gh.parent_installation.id
API,path_info,http.path
API,private_repo,gh.repo.is_private
API,query_owning_catalog_service,gh.graphql.catalog_service
API,query_string,http.query
API,rails,rails.version
API,rate_limit_family,gh.rate_limit.primary.family
API,rate_limit_key,gh.rate_limit.primary.key
API,rate_limit_remaining,gh.rate_limit.primary.remaining
API,rate_limit_reset,gh.rate_limit.primary.reset
API,rate_limit_used,gh.rate_limit.primary.used
API,rate_limit,gh.rate_limit.primary.max
API,referrer_controller_action,gh.graphql.referrer.controller_action
API,repo_id,gh.repo.id
API,request_category,gh.request.category
API,request_id,gh.request_id
API,request_wait_time,gh.request.wait_duration
API,requested_api_version,gh.api.requested_version
API,requested_at,gh.request.start_time
API,robot,gh.robot.type
API,route,http.route
API,selected_api_version_reason,gh.api.selected_version_reason
API,selected_api_version,gh.api.selected_version
API,server_id,service.instance.id
API,time,gh.exception.create_time
API,twirp_client_name,peer.service
API,twirp_client,peer.service
API,twirp_handler_class,rpc.service
API,twirp_rpc_method,rpc.method
API,unconverted_path,gh.api.is_unconverted_path
API,url_pattern,gh.graphql.referrer.http.route
API,user_agent,http.request.header.user_agent
API,user_programmatic_access_id,gh.user_programmatic_access.id
API,version,gh.api.version
API,viewer,gh.graphql.viewer.id
API,worker_pid,process.pid
API,worker_request_count,http.server.request.count
API,worker_started_at,gh.process.started_at
API,x_forwarded_for,http.request.header.x_forwarded_for
API,x_real_ip,http.request.header.x_real_ip
API,tenant,gh.tenant.id
API,user,gh.user.id
API,current_user,gh.actor.id
API,current_user,gh.actor.login
API,org,gh.organization.id
API,org,gh.organization.login
API,viewer,gh.graphql.viewer.id
1 Category Old Attribute New Attribute
2 Aqueduct kube_cluster k8s.cluster.name
3 Aqueduct kube_app k8s.app.name
4 Aqueduct kube_pod_namespace k8s.pod.namespace
5 Aqueduct kube_pod k8s.pod.name
6 Aqueduct kube_pod_ip k8s.pod.ip
7 Aqueduct current_ref aqueduct.ref
8 Aqueduct cluster aqueduct.cluster.name
9 Aqueduct Bridge current_ref aqueduct-bridge.ref
10 Pull Requests pull gh.pull_request.id
11 Pull Requests pull_valid gh.pull_request.valid
12 Pull Requests pull_saved gh.pull_request.saved
13 Pull Requests pull_errors gh.pull_request.errors
14 Pull Requests issue_valid gh.issue.valid
15 Pull Requests issue_saved gh.issue.saved
16 Pull Requests issue_errors gh.issue.errors
17 Viewscreen action gh.viewscreen.action
18 Viewscreen format gh.viewscreen.format
19 gitcoin/billing business_id gh.business.id
20 gitcoin/billing failed_event code.namespace
21 gitcoin/billing job gh.job.name
22 gitcoin/billing customer_id gh.customer.id
23 gitcoin/billing product gh.product.name
24 gitcoin/billing legacy gh.billing.legacy.status
25 gitcoin/billing purpose gh.billing.synchronization.purpose
26 gitcoin/billing user_id gh.user.id
27 gitcoin/billing plan_name gh.plan.name
28 gitcoin/billing attempts_per_exception gh.job.attempt.count
29 gitcoin/billing account_id gh.billing.zuora_account.id
30 gitcoin/billing owner_id gh.user.id
31 gitcoin/billing asset_status_id gh.asset_status.id
32 gitcoin/billing user gh.user.id
33 gitcoin/billing billing_transaction_id gh.billing.transaction.id
34 gitcoin/billing twirp_error_code http.status.code
35 gitcoin/billing name http.method
36 gitcoin/billing user gh.target.id
37 gitcoin/billing business gh.business.id
38 gitcoin/billing results gh.billing.plan_subscription.synchronization.results
39 gitcoin/billing zuora_account_id gh.billing.zuora_account.id
40 gitcoin/billing message gh.billing.result.error_message
41 gitcoin/billing message gh.billing.zuora.result.error_message
42 gitcoin/billing name code.function
43 gitcoin/billing stripe_transfer_id gh.billing.stripe_transfer.id
44 gitcoin/billing account_id gh.account.id
45 gitcoin/billing account_type gh.account.type
46 gitcoin/billing subscription_item_id gh.billing.subscription_item.id
47 gitcoin/billing target gh.target.id
48 gitcoin/billing processor code.namespace
49 gitcoin/billing zuora_invoice_id gh.billing.zuora_invoice.id
50 gitcoin/billing zuora_error_result gh.billing.zuora.result
51 gitcoin/billing invoice_id gh.billing.zuora.invoice.id
52 gitcoin/billing adjustment_amount gh.billing.zuora.invoice_adjustment.amount
53 gitcoin/billing adjustments gh.billing.zuora.adjustments
54 gitcoin/billing message gh.billing.braintree.response.message
55 gitcoin/billing gh.user.login gh.user.id
56 gitcoin/billing gh.billing.billable_entity.name gh.billing.billable_entity.id
57 notebooks repository_id gh.repo.id
58 notebooks commit gh.git.sha
59 notebooks browser browser.brands
60 notebooks version browser.brands
61 notebooks kube_cluster_name k8s.cluster.name
62 notebooks path url.path
63 notebooks is_iframe gh.notebooks.is_iframe
64 notebooks source gh.notebooks.error.source
65 notebooks repository_type gh.notebooks.repo_type
66 notebooks view_type gh.notebooks.view_type
67 notebooks LFS gh.notebooks.LFS
68 notebooks bypass_fastly gh.notebooks.bypass_fastly
69 notebooks fastly-cache-hit gh.notebooks.fastly_cache_hit
70 notebooks codeload_response gh.notebooks.codeload.response
71 notebooks codeload_status_code gh.notebooks.codeload.status
72 notebooks language gh.notebooks.notebook.language
73 notebooks visibility gh.notebooks.notebook.visibility
74 notebooks file_size gh.notebooks.notebook.size
75 notebooks notebook_version gh.notebooks.notebook.version
76 Pull Requests method gh.pull_request.merge_method
77 Pull Requests head_oid gh.pull_request.head_oid
78 Pull Requests base_oid gh.pull_request.base_oid
79 Pull Requests root_oid gh.pull_request.root_oid
80 Pull Requests comment_id gh.comment.id
81 Pull Requests user_id gh.owner.id
82 Pull Requests force_pushed gh.pull_request.force_pushed
83 Pull Requests pusher gh.pull_request.pusher.id
84 Pull Requests ref_name gh.merge_queue.ref_name_suffix
85 Pull Requests ref_sha gh.merge_queue.ref_sha
86 Pull Requests gh.merge_queue.branch gh.merge_queue.id
87 Pull Requests queue_id gh.merge_queue.id
88 Pull Requests record_errors gh.merge_queue.record_errors
89 Pull Requests new_head_ref gh.pull_request.new_head_ref
90 Pull Requests job_id gh.pull_request.job.id
91 Pull Requests spec gh.repo.dgit_spec
92 Pull Requests thread gh.pull_request_review_thread.id
93 Pull Requests reason_code gh.pull_request.reason_code
94 Pull Requests auto_merge_request_id gh.auto_merge_request.id
95 Pull Requests solo gh.auto_merge_request.solo
96 Pull Requests jump_queue gh.auto_merge_request.jump_queue
97 Pull Requests head_repo_id gh.pull_request.head_repo.id
98 Pull Requests branch gh.merge_queue.branch
99 Pull Requests guid gh.pull_request.guid
100 Pull Requests fn code.namespace,code.function
101 Pull Requests organization gh.organization
102 Pull Requests result gh.merge_queue.result
103 Pull Requests feature_flag gh.merge_queue.feature_flag
104 Pull Requests plan_support gh.merge_queue.plan_support
105 Pull Requests github_owned gh.merge_queue.github_owned
106 Pull Requests direct_compare gh.pull_request.comparison.direct
107 Pull Requests head_ref_valid gh.pull_request.head_ref.valid
108 Pull Requests comparison_viewable gh.pull_request.comparison.viewable
109 Pull Requests comparison_valid gh.pull_request.comparison.valid
110 Pull Requests pull_valid gh.pull_request.valid
111 Pull Requests pull_saved gh.pull_request.saved
112 Pull Requests pull_errors gh.pull_request.errors
113 API accept http.request.header.accept
114 API api_route http.route
115 API auth_fingerprint gh.auth.fingerprint
116 API auth gh.auth.type
117 API connections gh.db.connection_map
118 API content_authorization_failure gh.auth.failure.name
119 API controller code.namespace
120 API critical gh.exception.is_critical
121 API current_user gh.actor.id
122 API granted_oauth_scopes enduser.scope
123 API graphql_current_field gh.graphql.current_field
124 API graphql_current_path gh.graphql.current_path
125 API graphql_global_id_type gh.graphql.global_id_type
126 API graphql_query_hash gh.graphql.query_hash
127 API graphql_schema_target gh.graphql.schema_target
128 API graphql_variables_hash gh.graphql.variables_hash
129 API graphql gh.request.is_graphql
130 API installation_id gh.integration_installation.id
131 API integration_id gh.integration.id
132 API integration gh.integration.id
133 API is_employee gh.user.is_employee
134 API is_protected_by_hmac gh.api.is_protected_by_hmac
135 API language http.request.header.accept_language
136 API limited_index gh.rate_limit.secondary.search_index
137 API limited_key gh.rate_limit.secondary.key
138 API limited_limit gh.rate_limit.secondary.max
139 API limited_ttl gh.rate_limit.secondary.ttl
140 API limited gh.rate_limit.secondary.limit_reason
141 API master_pid process.parent_pid
142 API master_started_at gh.process.parent.started_at
143 API method http.method
144 API oauth_access_id gh.oauth.access.id
145 API oauth_app gh.oauth.app.id
146 API oauth_application_id gh.oauth.app.id
147 API oauth_party gh.oauth.app.party_type
148 API oauth_scopes enduser.scope
149 API operation_name graphql.operation.name
150 API org gh.organization.login
151 API origin gh.graphql.origin
152 API params http.request.parameters.*
153 API parent_installation_id gh.parent_installation.id
154 API path_info http.path
155 API private_repo gh.repo.is_private
156 API query_owning_catalog_service gh.graphql.catalog_service
157 API query_string http.query
158 API rails rails.version
159 API rate_limit_family gh.rate_limit.primary.family
160 API rate_limit_key gh.rate_limit.primary.key
161 API rate_limit_remaining gh.rate_limit.primary.remaining
162 API rate_limit_reset gh.rate_limit.primary.reset
163 API rate_limit_used gh.rate_limit.primary.used
164 API rate_limit gh.rate_limit.primary.max
165 API referrer_controller_action gh.graphql.referrer.controller_action
166 API repo_id gh.repo.id
167 API request_category gh.request.category
168 API request_id gh.request_id
169 API request_wait_time gh.request.wait_duration
170 API requested_api_version gh.api.requested_version
171 API requested_at gh.request.start_time
172 API robot gh.robot.type
173 API route http.route
174 API selected_api_version_reason gh.api.selected_version_reason
175 API selected_api_version gh.api.selected_version
176 API server_id service.instance.id
177 API time gh.exception.create_time
178 API twirp_client_name peer.service
179 API twirp_client peer.service
180 API twirp_handler_class rpc.service
181 API twirp_rpc_method rpc.method
182 API unconverted_path gh.api.is_unconverted_path
183 API url_pattern gh.graphql.referrer.http.route
184 API user_agent http.request.header.user_agent
185 API user_programmatic_access_id gh.user_programmatic_access.id
186 API version gh.api.version
187 API viewer gh.graphql.viewer.id
188 API worker_pid process.pid
189 API worker_request_count http.server.request.count
190 API worker_started_at gh.process.started_at
191 API x_forwarded_for http.request.header.x_forwarded_for
192 API x_real_ip http.request.header.x_real_ip
193 API tenant gh.tenant.id
194 API user gh.user.id
195 API current_user gh.actor.id
196 API current_user gh.actor.login
197 API org gh.organization.id
198 API org gh.organization.login
199 API viewer gh.graphql.viewer.id

View File

@@ -1080,7 +1080,7 @@ git-import-svn-raw
### git-import-tfs-raw
This utility imports from Team Foundation Version Control (TFVC). For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-from-other-version-control-systems-with-the-administrative-shell))."
This utility imports from Team Foundation Version Control (TFVC). For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-from-other-version-control-systems-with-the-administrative-shell)."
```shell
git-import-tfs-raw
@@ -1173,6 +1173,26 @@ In this example, `ghe-repl-status -vv` sends verbose status information from a r
## Upgrading {% data variables.product.prodname_ghe_server %}
{% ifversion ghes-upgrade-complete-indicator %}
### ghe-check-background-upgrade-jobs
During an upgrade to a feature release, this utility displays the status of background jobs on {% data variables.location.product_location %}. If you're running back-to-back upgrades, you should use this utility to check that all background jobs are complete before proceeding with the next upgrade.
{% ifversion ghes < 3.12 %}
{% note %}
**Note:** To use `ghe-check-background-upgrade-jobs` with {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }}, your instance must run version {{ allVersions[currentVersion].currentRelease }}.{% ifversion ghes = 3.8 %}12{% elsif ghes = 3.9 %}7{% elsif ghes = 3.10 %}4{% elsif ghes = 3.11 %}1{% endif %} or later.
{% endnote %}
{% endif %}
```shell
ghe-check-background-upgrade-jobs
```
{% endif %}
{% ifversion ghe-migrations-cli-utility %}
### ghe-migrations
@@ -1274,7 +1294,7 @@ This utility will enforce the default organization membership visibility setting
ghe-org-membership-update --visibility=SETTING
```
### `ghe-user-csv`
### ghe-user-csv
This utility exports a list of all the users in the installation into CSV format. The CSV file includes the email address, which type of user they are (e.g., admin, user), how many repositories they have, how many SSH keys, how many organization memberships, last logged IP address, etc. Use the `-h` flag for more options.

View File

@@ -69,7 +69,7 @@ Additional data is transmitted if you enable individual features of {% data vari
| Feature | Data | Which way does the data flow? | Where is the data used? |
| ------- | ---- | --------- | ------ |{% ifversion ghes %}
Automatic user license sync | Each {% data variables.product.product_name %} user's user ID and email addresses | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes %}
Automatic user license sync | Each {% data variables.product.product_name %} user's user ID and email addresses{% ifversion ghas-in-license-sync %}, and whether the user consumes a license for {% data variables.product.prodname_GH_advanced_security %}{% endif %} | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes %}
{% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %}
{% data variables.product.prodname_dependabot_updates %} | Dependencies and the metadata for each dependency's repository<br><br>If a dependency is stored in a private repository on {% data variables.product.prodname_dotcom_the_website %}, data will only be transmitted if {% data variables.product.prodname_dependabot %} is configured and authorized to access that repository. | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %}
{% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %}

View File

@@ -30,7 +30,7 @@ topics:
- If youre several versions behind, upgrade {% data variables.location.product_location %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step.
- Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %}
- Use a staging instance to test the upgrade steps. For more information, see "[AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)."
- When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete.
- When running multiple upgrades, {% ifversion ghes-upgrade-complete-indicator %}ensure data migrations and upgrade tasks running in the background are fully complete before proceeding to the next feature upgrade. To check the status of these processes, you can use the `ghe-migrations` and `ghe-check-background-upgrade-jobs` command-line utilities. {% ifversion ghes < 3.12 %} To use `ghe-check-background-upgrade-jobs` with {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }}, your instance must run version {{ allVersions[currentVersion].currentRelease }}.{% ifversion ghes = 3.8 %}12{% elsif ghes = 3.9 %}7{% elsif ghes = 3.10 %}4{% elsif ghes = 3.11 %}1{% endif %} or later. {% endif %}For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#upgrading-github-enterprise-server)."{% else %}wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete.{% endif %}
- Take a snapshot before upgrading your virtual machine. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#taking-a-snapshot)."
- Ensure you have a recent, successful backup of your instance. For more information, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README.md file](https://github.com/github/backup-utils#readme).

View File

@@ -216,7 +216,14 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea
{%- ifversion ghe-migrations-cli-utility %}
1. Optionally, during an upgrade to a feature release, you can monitor the status of database migrations using the `ghe-migrations` utility. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-migrations)."
{%- endif %}
1. After the instance restarts, the upgrade will continue in the background. You cannot unset maintenance mode until the process completes. To monitor progress, read the output in `/data/user/common/ghe-config.log`. For example, you can tail the log by running the following command:
1. After the instance restarts, the upgrade will continue in the background. You cannot unset maintenance mode until the process completes.
{% ifversion ghes-upgrade-complete-indicator %}
To check the status of background jobs, use the `ghe-check-background-upgrade-jobs` utility. If you're running back-to-back upgrades, you must ensure background jobs are complete before proceeding with the following upgrade to a feature release.
{%- ifversion ghes < 3.12 %} To use this utility with {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }}, your instance must run version {{ allVersions[currentVersion].currentRelease }}.{% ifversion ghes = 3.8 %}12{% elsif ghes = 3.9 %}7{% elsif ghes = 3.10 %}4{% elsif ghes = 3.11 %}1{% endif %} or later.{% endif %}{%- endif %} For more information{% ifversion ghes < 3.12 %} about the utility{% endif %}, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-check-background-upgrade-jobs)."
To monitor progress of the configuration run, read the output in `/data/user/common/ghe-config.log`. For example, you can tail the log by running the following command:
```shell
tail -f /data/user/common/ghe-config.log

View File

@@ -128,4 +128,8 @@ When you decide which repositories and organizations to prioritize for {% data v
When you have enabled {% data variables.product.prodname_GH_advanced_security %} for these organizations or repositories, assess which other codebases you could add without incurring billing for unique {% ifversion ghas-billing-UI-update %}active {% endif %}committers. Finally, review the remaining important and busy codebases. {% ifversion fpt or ghes or ghec %}If you want to increase the number of {% ifversion ghas-billing-UI-update %}licensed active committers, {% else %}seats in your license, {% endif %}contact {% data variables.contact.contact_enterprise_sales %}.{% endif %}
{% ifversion ghas-in-license-sync %}
If your enterprise uses {% data variables.product.prodname_GH_advanced_security %} on both {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}, you can ensure users aren't consuming multiple licenses unnecessarily by synchronizing license usage between environments.{% ifversion ghec %} {% data variables.product.prodname_GH_advanced_security %} is included in license sync in {% data variables.product.prodname_ghe_server %} version 3.12 and later.{% endif %} For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)."
{% endif %}
{% endif %}

View File

@@ -57,10 +57,16 @@ The license usage report for your enterprise is a CSV file that contains the fol
| github_com_verified_domain_emails | All email addresses associated with the user's GHEC account that match your enterprise's verified domains |
| github_com_saml_name_id | The SAML username |
| github_com_orgs_with_pending_invites | All pending invitations for the user's GHEC account to join organizations within your enterprise |
{%- ifversion ghas-in-license-sync %}
| github_com_advanced_security_license_user | Whether or not the user consumes a {% data variables.product.prodname_GH_advanced_security %} license on GHEC |
{%- endif %}
| license_type | Can be one of: `Visual Studio subscription` or `Enterprise`
| enterprise_server_user| Whether or not the user has at least one account on GHES |
| enterprise_server_primary_emails | The primary email addresses associated with each of the user's GHES accounts |
| enterprise_server_user_ids | For each of the user's GHES accounts, the account's user ID
{%- ifversion ghas-in-license-sync %}
| enterprise_server_advanced_security_user_ids | The GHES instances where the user is using {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghec %}(only present if you are using GHES version 3.12 or later, and have enabled license sync){% endif %} |
{%- endif %}
| total_user_accounts | The total number of accounts the person has across both GHEC and GHES
| visual_studio_subscription_user | Whether or not the user is a {% data variables.visual_studio.prodname_vs_subscriber %} |
| visual_studio_subscription_email | The email address associated with the user's VSS |

View File

@@ -72,9 +72,11 @@ http(s)://HOSTNAME/
Your {% data variables.product.product_name %} installation's API endpoints accept the same authentication methods as the {% data variables.product.prodname_dotcom %} API. For more information, see "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)."
{% ifversion ghes %}OAuth tokens must have the `site_admin` [OAuth scope](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %}
OAuth tokens must have the `site_admin` [OAuth scope](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes) when used with these endpoints.
These endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the [Management Console](/rest/enterprise-admin/management-console) endpoints, which requires the [Management Console password](/admin/configuration/administering-your-instance-from-the-management-console){% endif %}.
These endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators, except for the [Management Console](/rest/enterprise-admin/management-console) endpoints, which requires the [Management Console password](/admin/configuration/administering-your-instance-from-the-management-console).
{% data reusables.enterprise_management_console.api-deprecation %}
{% endif %}

View File

@@ -10,9 +10,9 @@ topics:
autogenerated: rest
---
## About the Management Console
## About the {% data variables.enterprise.management_console %}
{% tip %}
{% data reusables.enterprise_management_console.api-deprecation %}
You should explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`. Otherwise, the port number is `8080`.
@@ -20,8 +20,6 @@ If you cannot provide a port number, you'll need to configure your tool to autom
You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/admin/configuration/configuring-network-settings/configuring-tls).
{% endtip %}
### Authentication {% ifversion enterprise-management-console-multi-user-auth %}as the root site administrator{% endif %}
You need to pass your [{% ifversion enterprise-management-console-multi-user-auth %}root site administrator{% else %}{% data variables.enterprise.management_console %}{% endif %} password](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console) as an authentication token to every endpoint in this category except "[Create a GitHub license](#create-a-github-license)."

View File

@@ -1,10 +1,11 @@
---
title: Rule Suites
shortTitle: Rule Suites
intro: 'Use the REST API to manage rule suites for organizations.'
intro: Use the REST API to manage rule suites for organizations.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
ghes: '>=3.12'
topics:
- API
autogenerated: rest

View File

@@ -1,10 +1,11 @@
---
title: Rule Suites
shortTitle: Rule Suites
intro: 'Use the REST API to manage rule suites for repositories.'
intro: Use the REST API to manage rule suites for repositories.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
ghes: '>=3.12'
topics:
- API
autogenerated: rest

View File

@@ -0,0 +1,5 @@
# Reference: #12566
# GitHub Advanced Security license usage is included in license sync
versions:
ghec: '*'
ghes: '>=3.12'

View File

@@ -0,0 +1,4 @@
# Reference: #12410
# The ghe-check-background-upgrade-jobs command line utility
versions:
ghes: '>=3.8'

View File

@@ -0,0 +1,5 @@
# Reference: #12903
# Feature parity between the Management Console API and the Manage GHES API
versions:
ghes: '>=3.12'

View File

@@ -0,0 +1,137 @@
- title: Access to package version deletion
description: >-
This preview adds support for the DeletePackageVersion mutation which
enables deletion of private package versions.
toggled_by: ':package-deletes-preview'
announcement: null
updates: null
toggled_on:
- Mutation.deletePackageVersion
owning_teams:
- '@github/pe-package-registry'
- title: Deployments
description: >-
This preview adds support for deployments mutations and new deployments
features.
toggled_by: ':flash-preview'
announcement: null
updates: null
toggled_on:
- DeploymentStatus.environment
- Mutation.createDeploymentStatus
- CreateDeploymentStatusInput
- CreateDeploymentStatusPayload
- Mutation.createDeployment
- CreateDeploymentInput
- CreateDeploymentPayload
owning_teams:
- '@github/c2c-actions-service'
- title: >-
MergeInfoPreview - More detailed information about a pull request's merge
state.
description: >-
This preview adds support for accessing fields that provide more detailed
information about a pull request's merge state.
toggled_by: ':merge-info-preview'
announcement: null
updates: null
toggled_on:
- PullRequest.canBeRebased
- PullRequest.mergeStateStatus
owning_teams:
- '@github/pe-pull-requests'
- title: UpdateRefsPreview - Update multiple refs in a single operation.
description: This preview adds support for updating multiple refs in a single operation.
toggled_by: ':update-refs-preview'
announcement: null
updates: null
toggled_on:
- Mutation.updateRefs
- GitRefname
- RefUpdate
- UpdateRefsInput
- UpdateRefsPayload
owning_teams:
- '@github/repos'
- title: Access to a Repository's Dependency Graph
description: This preview adds support for reading a dependency graph for a repository.
toggled_by: ':hawkgirl-preview'
announcement: null
updates: null
toggled_on:
- DependencyGraphManifest
- Repository.dependencyGraphManifests
- DependencyGraphManifestEdge
- DependencyGraphManifestConnection
- DependencyGraphDependency
- DependencyGraphDependencyEdge
- DependencyGraphDependencyConnection
owning_teams:
- '@github/dependency-graph'
- title: Project Event Details
description: >-
This preview adds project, project card, and project column details to
project-related issue events.
toggled_by: ':starfox-preview'
announcement: null
updates: null
toggled_on:
- AddedToProjectEvent.project
- AddedToProjectEvent.projectCard
- AddedToProjectEvent.projectColumnName
- ConvertedNoteToIssueEvent.project
- ConvertedNoteToIssueEvent.projectCard
- ConvertedNoteToIssueEvent.projectColumnName
- MovedColumnsInProjectEvent.project
- MovedColumnsInProjectEvent.projectCard
- MovedColumnsInProjectEvent.projectColumnName
- MovedColumnsInProjectEvent.previousProjectColumnName
- RemovedFromProjectEvent.project
- RemovedFromProjectEvent.projectColumnName
owning_teams:
- '@github/github-projects'
- title: Labels Preview
description: >-
This preview adds support for adding, updating, creating and deleting
labels.
toggled_by: ':bane-preview'
announcement: null
updates: null
toggled_on:
- Mutation.createLabel
- CreateLabelPayload
- CreateLabelInput
- Mutation.deleteLabel
- DeleteLabelPayload
- DeleteLabelInput
- Mutation.updateLabel
- UpdateLabelPayload
- UpdateLabelInput
owning_teams:
- '@github/pe-pull-requests'
- title: Import Project
description: This preview adds support for importing projects.
toggled_by: ':slothette-preview'
announcement: null
updates: null
toggled_on:
- Mutation.importProject
owning_teams:
- '@github/pe-issues-projects'
- title: Team Review Assignments Preview
description: >-
This preview adds support for updating the settings for team review
assignment.
toggled_by: ':stone-crop-preview'
announcement: null
updates: null
toggled_on:
- Mutation.updateTeamReviewAssignment
- UpdateTeamReviewAssignmentInput
- TeamReviewAssignmentAlgorithm
- Team.reviewRequestDelegationEnabled
- Team.reviewRequestDelegationAlgorithm
- Team.reviewRequestDelegationMemberCount
- Team.reviewRequestDelegationNotifyTeam
owning_teams:
- '@github/pe-pull-requests'

View File

@@ -0,0 +1,474 @@
---
upcoming_changes:
- location: LegacyMigration.uploadUrlTemplate
description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.'
reason:
'`uploadUrlTemplate` is being removed because it is not a standard URL and
adds an extra user step.'
date: '2019-04-01T00:00:00+00:00'
criticality: breaking
owner: tambling
- location: AssignedEvent.user
description: '`user` will be removed. Use the `assignee` field instead.'
reason: Assignees can now be mannequins.
date: '2020-01-01T00:00:00+00:00'
criticality: breaking
owner: tambling
- location: UnassignedEvent.user
description: '`user` will be removed. Use the `assignee` field instead.'
reason: Assignees can now be mannequins.
date: '2020-01-01T00:00:00+00:00'
criticality: breaking
owner: tambling
- location: Issue.timeline
description: '`timeline` will be removed. Use Issue.timelineItems instead.'
reason: '`timeline` will be removed'
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: mikesea
- location: PullRequest.timeline
description: '`timeline` will be removed. Use PullRequest.timelineItems instead.'
reason: '`timeline` will be removed'
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: mikesea
- location: MergeStateStatus.DRAFT
description: '`DRAFT` will be removed. Use PullRequest.isDraft instead.'
reason:
DRAFT state will be removed from this enum and `isDraft` should be used
instead
date: '2021-01-01T00:00:00+00:00'
criticality: breaking
owner: nplasterer
- location: PackageType.DOCKER
description: '`DOCKER` will be removed.'
reason:
DOCKER will be removed from this enum as this type will be migrated to only
be used by the Packages REST API.
date: '2021-06-21'
criticality: breaking
owner: reybard
- location: ReactionGroup.users
description: '`users` will be removed. Use the `reactors` field instead.'
reason: Reactors can now be mannequins, bots, and organizations.
date: '2021-10-01T00:00:00+00:00'
criticality: breaking
owner: synthead
- location: AddPullRequestToMergeQueueInput.branch
description: '`branch` will be removed.'
reason:
PRs are added to the merge queue for the base branch, the `branch` argument
is now a no-op
date: '2022-07-01T00:00:00+00:00'
criticality: breaking
owner: jhunschejones
- location: DependencyGraphDependency.packageLabel
description:
'`packageLabel` will be removed. Use normalized `packageName` field
instead.'
reason: '`packageLabel` will be removed.'
date: '2022-10-01T00:00:00+00:00'
criticality: breaking
owner: github/dependency_graph
- location: RemovePullRequestFromMergeQueueInput.branch
description: '`branch` will be removed.'
reason:
PRs are removed from the merge queue for the base branch, the `branch` argument
is now a no-op
date: '2022-10-01T00:00:00+00:00'
criticality: breaking
owner: jhunschejones
- location: PackageType.NPM
description: '`NPM` will be removed.'
reason:
NPM will be removed from this enum as this type will be migrated to only
be used by the Packages REST API.
date: '2022-11-21'
criticality: breaking
owner: s-anupam
- location: PackageType.NUGET
description: '`NUGET` will be removed.'
reason:
NUGET will be removed from this enum as this type will be migrated to only
be used by the Packages REST API.
date: '2022-11-21'
criticality: breaking
owner: s-anupam
- location: PackageType.RUBYGEMS
description: '`RUBYGEMS` will be removed.'
reason:
RUBYGEMS will be removed from this enum as this type will be migrated to
only be used by the Packages REST API.
date: '2022-12-28'
criticality: breaking
owner: ankitkaushal01
- location: Commit.changedFiles
description: '`changedFiles` will be removed. Use `changedFilesIfAvailable` instead.'
reason: '`changedFiles` will be removed.'
date: '2023-01-01T00:00:00+00:00'
criticality: breaking
owner: adamshwert
- location: ProjectV2View.visibleFields
description:
'`visibleFields` will be removed. Check out the `ProjectV2View#fields`
API as an example for the more capable alternative.'
reason:
The `ProjectV2View#visibleFields` API is deprecated in favour of the more
capable `ProjectV2View#fields` API.
date: '2023-01-01T00:00:00+00:00'
criticality: breaking
owner: mattruggio
- location: PackageType.MAVEN
description: '`MAVEN` will be removed.'
reason:
MAVEN will be removed from this enum as this type will be migrated to only
be used by the Packages REST API.
date: '2023-02-10'
criticality: breaking
owner: ankitkaushal01
- location: ProjectV2View.groupBy
description:
'`groupBy` will be removed. Check out the `ProjectV2View#group_by_fields`
API as an example for the more capable alternative.'
reason:
The `ProjectV2View#order_by` API is deprecated in favour of the more capable
`ProjectV2View#group_by_field` API.
date: '2023-04-01T00:00:00+00:00'
criticality: breaking
owner: alcere
- location: ProjectV2View.sortBy
description:
'`sortBy` will be removed. Check out the `ProjectV2View#sort_by_fields`
API as an example for the more capable alternative.'
reason:
The `ProjectV2View#sort_by` API is deprecated in favour of the more capable
`ProjectV2View#sort_by_fields` API.
date: '2023-04-01T00:00:00+00:00'
criticality: breaking
owner: traumverloren
- location: ProjectV2View.verticalGroupBy
description:
'`verticalGroupBy` will be removed. Check out the `ProjectV2View#vertical_group_by_fields`
API as an example for the more capable alternative.'
reason:
The `ProjectV2View#vertical_group_by` API is deprecated in favour of the
more capable `ProjectV2View#vertical_group_by_fields` API.
date: '2023-04-01T00:00:00+00:00'
criticality: breaking
owner: traumverloren
- location: Repository.squashPrTitleUsedAsDefault
description:
'`squashPrTitleUsedAsDefault` will be removed. Use `Repository.squashMergeCommitTitle`
instead.'
reason: '`squashPrTitleUsedAsDefault` will be removed.'
date: '2023-04-01T00:00:00+00:00'
criticality: breaking
owner: github/pull_requests
- location: Commit.pushedDate
description: '`pushedDate` will be removed.'
reason: '`pushedDate` is no longer supported.'
date: '2023-07-01T00:00:00+00:00'
criticality: breaking
owner: darthwillis
- location: ProjectV2ItemFieldGroup.field
description:
'`field` will be removed. Check out the `ProjectV2ItemFieldGroup#groupByField`
API as an example for the more capable alternative.'
reason:
The `ProjectV2ItemFieldGroup#field` API is deprecated in favour of the more
capable `ProjectV2ItemFieldGroup#groupByField` API.
date: '2023-07-01T00:00:00+00:00'
criticality: breaking
owner: stevepopovich
- location: AddPullRequestReviewCommentInput.body
description:
'`body` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
instead'
reason: We are deprecating the addPullRequestReviewComment mutation
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: AddPullRequestReviewCommentInput.commitOID
description:
'`commitOID` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
instead'
reason: We are deprecating the addPullRequestReviewComment mutation
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: AddPullRequestReviewCommentInput.inReplyTo
description:
'`inReplyTo` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
instead'
reason: We are deprecating the addPullRequestReviewComment mutation
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: AddPullRequestReviewCommentInput.path
description:
'`path` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
instead'
reason: We are deprecating the addPullRequestReviewComment mutation
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: AddPullRequestReviewCommentInput.position
description:
'`position` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
instead'
reason: We are deprecating the addPullRequestReviewComment mutation
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: AddPullRequestReviewCommentInput.pullRequestId
description:
'`pullRequestId` will be removed. use addPullRequestReviewThread or
addPullRequestReviewThreadReply instead'
reason: We are deprecating the addPullRequestReviewComment mutation
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: AddPullRequestReviewCommentInput.pullRequestReviewId
description:
'`pullRequestReviewId` will be removed. use addPullRequestReviewThread
or addPullRequestReviewThreadReply instead'
reason: We are deprecating the addPullRequestReviewComment mutation
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: AddPullRequestReviewInput.comments
description: '`comments` will be removed. use the `threads` argument instead'
reason: We are deprecating comment fields that use diff-relative positioning
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: PullRequestReviewComment.originalPosition
description: '`originalPosition` will be removed.'
reason: We are phasing out diff-relative positioning for PR comments
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: PullRequestReviewComment.position
description:
'`position` will be removed. Use the `line` and `startLine` fields
instead, which are file line numbers instead of diff line numbers'
reason: We are phasing out diff-relative positioning for PR comments
date: '2023-10-01T00:00:00+00:00'
criticality: breaking
owner: aharpole
- location: CreateTeamDiscussionCommentInput.body
description:
'`body` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: CreateTeamDiscussionCommentInput.discussionId
description:
'`discussionId` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: CreateTeamDiscussionCommentPayload.teamDiscussionComment
description:
'`teamDiscussionComment` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: CreateTeamDiscussionInput.body
description:
'`body` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: CreateTeamDiscussionInput.private
description:
'`private` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: CreateTeamDiscussionInput.teamId
description:
'`teamId` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: CreateTeamDiscussionInput.title
description:
'`title` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: CreateTeamDiscussionPayload.teamDiscussion
description:
'`teamDiscussion` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.authorAssociation
description:
'`authorAssociation` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.bodyVersion
description:
'`bodyVersion` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.comments
description:
'`comments` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.commentsResourcePath
description:
'`commentsResourcePath` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.commentsUrl
description:
'`commentsUrl` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.isPinned
description:
'`isPinned` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.isPrivate
description:
'`isPrivate` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.number
description:
'`number` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.resourcePath
description:
'`resourcePath` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.team
description:
'`team` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.title
description:
'`title` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.url
description:
'`url` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussion.viewerCanPin
description:
'`viewerCanPin` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussionComment.authorAssociation
description:
'`authorAssociation` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussionComment.bodyVersion
description:
'`bodyVersion` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussionComment.discussion
description:
'`discussion` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussionComment.number
description:
'`number` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussionComment.resourcePath
description:
'`resourcePath` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges
- location: TeamDiscussionComment.url
description:
'`url` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/
to find a suitable replacement.'
reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
date: '2024-07-01T00:00:00+00:00'
criticality: breaking
owner: deborah-digges

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,177 @@
date: '2024-02-13'
release_candidate: true
deprecated: false
intro: |
{% note %}
**Note:** Release candidate (RC) builds are intended solely for use in a test environment. If {% data variables.location.product_location %} is running an RC, you cannot upgrade to the general availability (GA) release. You also cannot upgrade with a hotpatch.
{% endnote %}
For upgrade instructions, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)."
sections:
features:
- heading: Instance administration
notes:
# https://github.com/github/releases/issues/3542
- |
To ensure an instance's readiness for an upgrade to a new feature release of GitHub Enterprise Server, administrators can ensure that background tasks from a previous upgrade are complete using the `ghe-check-background-upgrade-jobs` command-line utility. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-a-standalone-instance-using-an-upgrade-package)" and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-check-background-upgrade-jobs)."
# https://github.com/github/releases/issues/3531
- |
When backing up an instance in a cluster configuration using GitHub Enterprise Server Backup Utilities, the pre-flight routine includes a health check for all nodes and notifies administrators of any issues before the backup begins.
# https://github.com/github/releases/issues/3659
- |
The REST API's `/manage/v1` endpoints have been expanded to include all the same operations as the `/setup/api` endpoints. The `/setup/api` endpoints will be deprecated in a future release of GitHub Enterprise Server. For more information, see the following articles in the REST API documentation.
- "[AUTOTITLE](/rest/enterprise-admin/manage-ghes)"
- "[AUTOTITLE](/rest/enterprise-admin/management-console)"
- heading: Authentication
notes:
# https://github.com/github/releases/issues/3682
- |
To manage work across different accounts and GitHub products, users can authenticate to the GitHub CLI with multiple accounts, then use the `gh auth switch` command to switch between active accounts. For more information, see [gh auth login](https://cli.github.com/manual/gh_auth_login) in the GitHub CLI manual.
- heading: GitHub Advanced Security
notes:
# https://github.com/github/releases/issues/3597
- |
The GitHub Advanced Security billing REST API and CSV download includes the email addresses for active committers. This provides information for insights into Advanced Security license usage across your business. For more information, see "[AUTOTITLE](/rest/enterprise-admin/billing)" and "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage#downloading-github-advanced-security-license-usage-information)".
# https://github.com/github/releases/issues/3285
- |
To make it easier for users to secure repositories, default setup for code scanning automatically attempts to analyze all languages supported by CodeQL. Users no longer need to manually include analysis of C, C++, C#, Java, or Kotlin when enabling default setup, and organization owners and security managers can enable analysis of these languages for multiple repositories in an organization. For more information about the languages and versions supported by CodeQL and code scanning, see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)" and [Supported languages and frameworks](https://codeql.github.com/docs/codeql-overview/supported-languages-and-frameworks/)" in the CodeQL documentation.
# https://github.com/github/releases/issues/3569
- |
Customers who use both GitHub Enterprise Server and GitHub Enterprise Cloud can ensure license usage for GitHub Advanced Security is calculated correctly by synchronizing license usage across deployments. Synchronization can be performed automatically, using GitHub Connect, or manually, using an export file. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)."
# https://github.com/github/releases/issues/3680
- |
For code scanning, this release of GitHub Enterprise Server uses version 2.15.5 of CodeQL by default. This version of CodeQL includes more up-to-date support for various languages, including C# 12, .NET 8, TypeScript 5.3, Java 21, and Python 3.12. For more information, see the [changelog for CodeQL 2.15.5](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.15.5/) in the CodeQL documentation.
# https://github.com/github/releases/issues/3521
- |
Code scanning with CodeQL has improved support for detecting vulnerabilities in C and C++ code, with queries available for detecting common memory-corruption vulnerabilities. These queries are in beta and subject to change. For more information, see [ICYMI: improved C++ vulnerability coverage and CodeQL support for Lombok](https://github.blog/2023-10-19-icymi-improved-c-vulnerability-coverage-and-codeql-support-for-lombok/#improved-c-vulnerability-coverage) on the GitHub Blog.
# https://github.com/github/releases/issues/3512
- |
For repositories migrated to GitHub Enterprise Server from other platforms, to calculate active committers for GitHub Advanced Security license usage, GitHub only considers commits made after the migration date. Previously, historic commits were included in the calculation, and users needed to intervene manually to avoid consuming licenses unnecessarily. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."
# https://github.com/github/releases/issues/3310
- |
To make the language overview on the tool status page more informative, users can directly specify `Kotlin`, `C`, and `TypeScript` as languages to be analyzed using the `language` property of a `codeql.yml` file. For example: `language: [ 'kotlin' ]`. These languages were already supported by CodeQL, but were previously treated as being part of the `Java`, `CPP`, and `JavaScript` languages respectively.
# https://github.com/github/releases/issues/3119
- |
To increase the coverage of secret scanning without needing to maintain custom patterns, users can configure secret scanning to detect non-provider patterns. Non-provider patterns are patterns such as private keys that tend to have a higher rate of false positives than high-confidence patterns. GitHub displays non-provider alerts in a different list from high-confidence alerts, making triaging a better experience for users. This feature is in beta and subject to change. For more information, see "[AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning#managing-alerts-from-non-provider-patterns)."
- heading: Dependabot
notes:
# https://github.com/github/releases/issues/3458
- |
To debug issues with Dependabot, users can view logs for Dependabot job runs associated with version updates, security updates, and rebase updates. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/viewing-dependabot-job-logs)."
# https://github.com/github/releases/issues/3091
- |
Users can choose how to respond to Dependabot alerts automatically by setting up custom auto-triage rules in repositories or organizations. Auto-triage rules provide control over whether an alert is ignored, is snoozed, or triggers a pull request for a security update. Users can also use a rule created by GitHub to automatically dismiss low-impact issues in npm dependencies. Auto-triage rules are in public beta and subject to change. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules)."
# https://github.com/github/releases/issues/3615
- |
Dependabot version updates have improved support for dependencies in NuGet, the package manager for .NET. Improvements include better support for implicit dependencies and peer dependencies. For more information about supported package managers, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates#supported-repositories-and-ecosystems)."
- heading: GitHub Actions
notes:
# https://github.com/github/releases/issues/3227
- |
Users can set up organization-wide rules to enforce their CI/CD workflows, ensuring workflows pass before pull requests can be merged into target repositories. You can fine-tune your rule by selecting a specific branch, tag, or SHA, and provide maximum control over the version expected to run. To reduce risk, you can "evaluate" workflow rules to validate rules are working correctly. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)".
# https://github.com/github/releases/issues/3417
- |
GitHub Actions developers can use GitHub Actions Importer to plan, forecast, and automate the migration of existing CI/CD pipelines from Bamboo Server, Bamboo Data Center, and Bitbucket. Developers can migrate their Bamboo and Bitbucket pipelines to GitHub Actions using the GitHub CLI or IssueOps. For more information, see "[AUTOTITLE](/actions/migrating-to-github-actions/automated-migrations/migrating-from-bitbucket-pipelines-with-github-actions-importer)" and "[AUTOTITLE](/actions/migrating-to-github-actions/automated-migrations/migrating-from-bamboo-with-github-actions-importer)".
# https://github.com/github/releases/issues/3508
- |
Actions environments support defining selected tag patterns to restrict deployments. Administrators who want to have more secure and controlled deployments can specify selected tags or tag patterns on their protected environments. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches)".
- heading: Community experience
notes:
# https://github.com/github/releases/issues/3529
- |
To tailor information to users' needs, users are prompted to sign in to access the [GitHub Support](https://support.github.com/) portal. For customers with an enterprise account on GitHub.com, we encourage users to sign in to an account with support privileges for the enterprise. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." Users who cannot sign in to an account on GitHub.com can still access the portal by verifying an email address.
# https://github.com/github/releases/issues/3605
- |
To help users find answers to their questions more quickly, GitHub Copilot is integrated into GitHub Support. Users can choose to chat with Copilot instead of creating a ticket on the "[Get help with GitHub](https://support.github.com/contact)" contact form. Copilot has been trained on the GitHub Enterprise Server documentation on GitHub Docs. This feature is in public beta and subject to change.
- heading: Projects
notes:
# https://github.com/github/releases/issues/2930
- |
Project templates for organizations are generally available. Users in an organization can create a template to share a pre-configured project with other people in your organization as the base for their projects. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization)".
# https://github.com/github/releases/issues/3549
- |
Users can access Projects from from the global navigation menu. This page can be used to find projects you've recently viewed or created, regardless of the organization or where they are located. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/finding-your-projects)".
- heading: GitHub Discussions
notes:
# https://github.com/github/releases/issues/3475
- |
Users can filter for answered or unanswered discussions with the GraphQL API by using the `answered` property. For more information, see "[AUTOTITLE](/graphql/guides/using-the-graphql-api-for-discussions)."
- heading: Pull requests
notes:
# https://github.com/github/releases/issues/3140
- |
Users can merge pull requests without needing to wait for status checks to pass by adding a pull request to a merge queue. The merge queue ensures that the changes in the pull request will pass all required status checks when applied to the latest version of the target branch. A pull request is merged automatically once it reaches the front of the queue. This feature is particularly useful on branches where pull requests are merged frequently. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)."
- heading: Markdown
notes:
# https://github.com/github/releases/issues/2339
- |
Users can highlight information using Markdown alerts. Alerts are displayed with distinctive colors and icons, and include notes, tips, warnings, and more. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)."
- heading: Accessibility
notes:
# https://github.com/github/releases/issues/3563
- |
The web interface for GitHub Enterprise Server has been redesigned to provide a more intuitive, responsive, and accessible navigation experience. Changes include:
- Breadcrumbs to help users navigate the site more efficiently
- Menus to quickly access a user's top repositories and teams
- A more accessible navigation experience, including more consistent keyboard navigation and improvements to code search
For more information, see [Exploring GitHub with the redesigned navigation](https://github.blog/2023-06-15-exploring-github-with-the-redesigned-navigation-now-in-public-beta/) on the GitHub Blog. Note that the redesigned navigation is now generally available.
# https://github.com/github/releases/issues/3595
- |
The comment field in issues, discussions, and pull requests has been redesigned for easier use across different screen sizes, and for better integration with assistive technology such as keyboard navigation and screen readers.
changes:
# https://github.com/github/docs-content/issues/12948
- |
Field names for some service logs on GitHub Enterprise Server have changed as part of GitHub's gradual migration to internal semantic conventions for [OpenTelemetry](https://opentelemetry.io/). Additional field names were changed in GitHub Enterprise Server 3.9, 3.10, and 3.11. If any tooling or processes in your environment rely on specific field names within logs, or log entries in specific files, the following changes may affect you.
- `level` is now `SeverityText`.
- `log_message`, `msg`, or `message` is now `Body`.
- `now` is now `Timestamp`.
- Custom field names such as `gh.repo.id` or `graphql.operation.name` use semantic names.
- Log statements that the instance would previously write to `auth.log`, `ldap.log`, or `ldap-sync.log` now appear in containerized logs for `github-unicorn` if the statement originated from a web request, or in logs for `github-resqued` if the statement originated from a background job. For more information about containerized logs, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/about-system-logs#system-logs-in-the-systemd-journal)."
For a full list of mappings, download the OpenTelemetry attribute mapping CSV for GitHub Enterprise Server [3.9](/assets/ghes-3.9-opentelemetry-attribute-mappings.csv), [3.10](/assets/ghes-3.10-opentelemetry-attribute-mappings.csv), [3.11](/assets/ghes-3.11-opentelemetry-attribute-mappings.csv), and [3.12](/assets/ghes-3-12-opentelemetry-attribute-mappings.csv).
# https://github.com/github/releases/issues/3579
- |
On an instance with GitHub Advanced Security and code scanning enabled, the bot that posts comments and annotations for code scanning alerts on pull requests has been renamed from `github-code-scanning` to `github-advanced-security`.
# https://github.com/github/releases/issues/3561
- |
The REST API's `/rate_limit` endpoint is now subject to rate limits. Requests will not consume the primary rate limit quotas for the authenticated user. However, making a very high number of requests in a short period of time will trigger the secondary rate limits if secondary rate limits are enabled on your instance. For more information, see "[AUTOTITLE](/rest/rate-limit/rate-limit)" in the REST API documentation and "[AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-rate-limits)."
known_issues:
- |
Custom firewall rules are removed during the upgrade process.
- |
During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start.
- |
If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)."
- |
If an instance is configured to forward logs to a target server with TLS enabled, certificate authority (CA) bundles that a site administrator uploads using `ghe-ssl-ca-certificate-install` are not respected, and connections to the server fail.
- |
The `mbind: Operation not permitted` error in the `/var/log/mysql/mysql.err` file can be ignored. MySQL 8 does not gracefully handle when the `CAP_SYS_NICE` capability isn't required, and outputs an error instead of a warning.
- |
{% data reusables.release-notes.2023-11-aws-system-time %}
- |
On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1.
- |
{% data reusables.release-notes.large-adoc-files-issue %}
- |
{% data reusables.release-notes.2023-11-cluster-ha-failover-git-push-failure %}
- |
Restoring backups with `ghe-restore` on a GHES cluster will exit prematurely if `redis` has not restarted properly.

View File

@@ -1 +1 @@
For a person using multiple {% data variables.product.prodname_enterprise %} environments to only consume a single license, you must synchronize license usage between environments. Then, {% data variables.product.company_short %} will deduplicate users based on the email addresses associated with their user accounts. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise#about-the-calculation-of-consumed-licenses)."
For a person using multiple {% data variables.product.prodname_enterprise %} environments to only consume a single license, you must synchronize license usage between environments. Then, {% data variables.product.company_short %} will deduplicate users based on the email addresses associated with their user accounts. {% data variables.product.company_short %} deduplicates licenses for the {% data variables.product.prodname_enterprise %} plan itself, {% ifversion ghas-in-license-sync %}and{% ifversion ghec %} if you use {% data variables.product.prodname_ghe_server %} version 3.12 or later,{% endif %} for {% data variables.product.prodname_GH_advanced_security %}{% else %}but not for other {% data variables.product.company_short %} products{% endif %}. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise#about-the-calculation-of-consumed-licenses)."

View File

@@ -0,0 +1,7 @@
{% ifversion management-console-manage-ghes-parity %}
{% note %}
**Note:** The {% data variables.enterprise.management_console %} endpoints will be deprecated in a future version of {% data variables.product.prodname_ghe_server %}. You can access the same functionality using the Manage {% data variables.product.prodname_ghe_server %} endpoints. For more information, see "[AUTOTITLE](/rest/enterprise-admin/manage-ghes)."
{% endnote %}
{% endif %}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,148 @@
[
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/c2c-actions-service"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Merge info preview more detailed information about a pull request's merge state preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview-more-detailed-information-about-a-pull-requests-merge-state-preview"
},
{
"title": "Update refs preview update multiple refs in a single operation preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/repos"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview-update-multiple-refs-in-a-single-operation-preview"
},
{
"title": "Access to a repository's dependency graph preview",
"description": "This preview adds support for reading a dependency graph for a repository.",
"toggled_by": "hawkgirl-preview",
"toggled_on": [
"DependencyGraphManifest",
"Repository.dependencyGraphManifests",
"DependencyGraphManifestEdge",
"DependencyGraphManifestConnection",
"DependencyGraphDependency",
"DependencyGraphDependencyEdge",
"DependencyGraphDependencyConnection"
],
"owning_teams": [
"@github/dependency-graph"
],
"accept_header": "application/vnd.github.hawkgirl-preview+json",
"href": "/graphql/overview/schema-previews#access-to-a-repositorys-dependency-graph-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
]

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,514 @@
{
"2024-07-01": [
{
"location": "TeamDiscussionComment.url",
"description": "<p><code>url</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussionComment.resourcePath",
"description": "<p><code>resourcePath</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussionComment.number",
"description": "<p><code>number</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussionComment.discussion",
"description": "<p><code>discussion</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussionComment.bodyVersion",
"description": "<p><code>bodyVersion</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussionComment.authorAssociation",
"description": "<p><code>authorAssociation</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.viewerCanPin",
"description": "<p><code>viewerCanPin</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.url",
"description": "<p><code>url</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.title",
"description": "<p><code>title</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.team",
"description": "<p><code>team</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.resourcePath",
"description": "<p><code>resourcePath</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.number",
"description": "<p><code>number</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.isPrivate",
"description": "<p><code>isPrivate</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.isPinned",
"description": "<p><code>isPinned</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.commentsUrl",
"description": "<p><code>commentsUrl</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.commentsResourcePath",
"description": "<p><code>commentsResourcePath</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.comments",
"description": "<p><code>comments</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.bodyVersion",
"description": "<p><code>bodyVersion</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "TeamDiscussion.authorAssociation",
"description": "<p><code>authorAssociation</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "CreateTeamDiscussionPayload.teamDiscussion",
"description": "<p><code>teamDiscussion</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "CreateTeamDiscussionInput.title",
"description": "<p><code>title</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "CreateTeamDiscussionInput.teamId",
"description": "<p><code>teamId</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "CreateTeamDiscussionInput.private",
"description": "<p><code>private</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "CreateTeamDiscussionInput.body",
"description": "<p><code>body</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "CreateTeamDiscussionCommentPayload.teamDiscussionComment",
"description": "<p><code>teamDiscussionComment</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "CreateTeamDiscussionCommentInput.discussionId",
"description": "<p><code>discussionId</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
},
{
"location": "CreateTeamDiscussionCommentInput.body",
"description": "<p><code>body</code> will be removed. Follow the guide at <a href=\"https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/\">https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/</a> to find a suitable replacement.</p>",
"reason": "<p>The Team Discussions feature is deprecated in favor of Organization Discussions.</p>",
"date": "2024-07-01",
"criticality": "breaking",
"owner": "deborah-digges"
}
],
"2023-10-01": [
{
"location": "PullRequestReviewComment.position",
"description": "<p><code>position</code> will be removed. Use the <code>line</code> and <code>startLine</code> fields instead, which are file line numbers instead of diff line numbers</p>",
"reason": "<p>We are phasing out diff-relative positioning for PR comments</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
},
{
"location": "PullRequestReviewComment.originalPosition",
"description": "<p><code>originalPosition</code> will be removed.</p>",
"reason": "<p>We are phasing out diff-relative positioning for PR comments</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
},
{
"location": "AddPullRequestReviewInput.comments",
"description": "<p><code>comments</code> will be removed. use the <code>threads</code> argument instead</p>",
"reason": "<p>We are deprecating comment fields that use diff-relative positioning</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
},
{
"location": "AddPullRequestReviewCommentInput.pullRequestReviewId",
"description": "<p><code>pullRequestReviewId</code> will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead</p>",
"reason": "<p>We are deprecating the addPullRequestReviewComment mutation</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
},
{
"location": "AddPullRequestReviewCommentInput.pullRequestId",
"description": "<p><code>pullRequestId</code> will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead</p>",
"reason": "<p>We are deprecating the addPullRequestReviewComment mutation</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
},
{
"location": "AddPullRequestReviewCommentInput.position",
"description": "<p><code>position</code> will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead</p>",
"reason": "<p>We are deprecating the addPullRequestReviewComment mutation</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
},
{
"location": "AddPullRequestReviewCommentInput.path",
"description": "<p><code>path</code> will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead</p>",
"reason": "<p>We are deprecating the addPullRequestReviewComment mutation</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
},
{
"location": "AddPullRequestReviewCommentInput.inReplyTo",
"description": "<p><code>inReplyTo</code> will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead</p>",
"reason": "<p>We are deprecating the addPullRequestReviewComment mutation</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
},
{
"location": "AddPullRequestReviewCommentInput.commitOID",
"description": "<p><code>commitOID</code> will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead</p>",
"reason": "<p>We are deprecating the addPullRequestReviewComment mutation</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
},
{
"location": "AddPullRequestReviewCommentInput.body",
"description": "<p><code>body</code> will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead</p>",
"reason": "<p>We are deprecating the addPullRequestReviewComment mutation</p>",
"date": "2023-10-01",
"criticality": "breaking",
"owner": "aharpole"
}
],
"2023-07-01": [
{
"location": "ProjectV2ItemFieldGroup.field",
"description": "<p><code>field</code> will be removed. Check out the <code>ProjectV2ItemFieldGroup#groupByField</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2ItemFieldGroup#field</code> API is deprecated in favour of the more capable <code>ProjectV2ItemFieldGroup#groupByField</code> API.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "stevepopovich"
},
{
"location": "Commit.pushedDate",
"description": "<p><code>pushedDate</code> will be removed.</p>",
"reason": "<p><code>pushedDate</code> is no longer supported.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "darthwillis"
}
],
"2023-04-01": [
{
"location": "Repository.squashPrTitleUsedAsDefault",
"description": "<p><code>squashPrTitleUsedAsDefault</code> will be removed. Use <code>Repository.squashMergeCommitTitle</code> instead.</p>",
"reason": "<p><code>squashPrTitleUsedAsDefault</code> will be removed.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "github/pull_requests"
},
{
"location": "ProjectV2View.verticalGroupBy",
"description": "<p><code>verticalGroupBy</code> will be removed. Check out the <code>ProjectV2View#vertical_group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#vertical_group_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#vertical_group_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.sortBy",
"description": "<p><code>sortBy</code> will be removed. Check out the <code>ProjectV2View#sort_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#sort_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#sort_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.groupBy",
"description": "<p><code>groupBy</code> will be removed. Check out the <code>ProjectV2View#group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#order_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#group_by_field</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "alcere"
}
],
"2023-02-10": [
{
"location": "PackageType.MAVEN",
"description": "<p><code>MAVEN</code> will be removed.</p>",
"reason": "<p>MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2023-02-10",
"criticality": "breaking",
"owner": "ankitkaushal01"
}
],
"2023-01-01": [
{
"location": "ProjectV2View.visibleFields",
"description": "<p><code>visibleFields</code> will be removed. Check out the <code>ProjectV2View#fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#visibleFields</code> API is deprecated in favour of the more capable <code>ProjectV2View#fields</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "mattruggio"
},
{
"location": "Commit.changedFiles",
"description": "<p><code>changedFiles</code> will be removed. Use <code>changedFilesIfAvailable</code> instead.</p>",
"reason": "<p><code>changedFiles</code> will be removed.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "adamshwert"
}
],
"2022-12-28": [
{
"location": "PackageType.RUBYGEMS",
"description": "<p><code>RUBYGEMS</code> will be removed.</p>",
"reason": "<p>RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-12-28",
"criticality": "breaking",
"owner": "ankitkaushal01"
}
],
"2022-11-21": [
{
"location": "PackageType.NUGET",
"description": "<p><code>NUGET</code> will be removed.</p>",
"reason": "<p>NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-11-21",
"criticality": "breaking",
"owner": "s-anupam"
},
{
"location": "PackageType.NPM",
"description": "<p><code>NPM</code> will be removed.</p>",
"reason": "<p>NPM will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-11-21",
"criticality": "breaking",
"owner": "s-anupam"
}
],
"2022-10-01": [
{
"location": "RemovePullRequestFromMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are removed from the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
},
{
"location": "DependencyGraphDependency.packageLabel",
"description": "<p><code>packageLabel</code> will be removed. Use normalized <code>packageName</code> field instead.</p>",
"reason": "<p><code>packageLabel</code> will be removed.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "github/dependency_graph"
}
],
"2022-07-01": [
{
"location": "AddPullRequestToMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are added to the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
}
],
"2020-10-01": [
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}

View File

@@ -194296,7 +194296,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>You must authenticate using an access\ntoken with the <code>repo</code> scope to use this endpoint. GitHub Apps must have write access to the <code>codespaces_secrets</code>\nrepository permission to use this endpoint.</p>",
"descriptionHTML": "<p>Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>You must authenticate using an access\ntoken with the <code>repo</code> scope to use this endpoint. GitHub Apps must have write access to the <code>codespaces_secrets</code>\nrepository permission to use this endpoint.</p>\n<p>This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see \"<a href=\"https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic\">Managing your personal access tokens</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -194365,7 +194365,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have write access to the <code>codespaces_secrets</code> repository permission to use this endpoint.</p>",
"descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have write access to the <code>codespaces_secrets</code> repository permission to use this endpoint.\nThis endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see \"<a href=\"https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic\">Managing your personal access tokens</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -235106,7 +235106,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>",
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -235430,7 +235430,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/rest/apps/apps#get-an-app\">GET an app</a>\".</p>",
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/rest/apps/apps#get-an-app\">GET an app</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -235592,7 +235592,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>",
"descriptionHTML": "<p>Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -391065,6 +391065,7 @@
"contentType": "application/json",
"description": "<p>Response</p>",
"example": {
"id": "4fd754f7e594640989b406850d0bc8f06a121251",
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status",
"page_url": "developer.github.com"
},
@@ -391073,6 +391074,17 @@
"description": "The GitHub Pages deployment status.",
"type": "object",
"properties": {
"id": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit."
},
"status_url": {
"type": "string",
"description": "The URI to monitor GitHub Pages deployment status.",
@@ -391099,6 +391111,7 @@
}
},
"required": [
"id",
"status_url",
"page_url"
]

View File

@@ -206475,7 +206475,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>You must authenticate using an access\ntoken with the <code>repo</code> scope to use this endpoint. GitHub Apps must have write access to the <code>codespaces_secrets</code>\nrepository permission to use this endpoint.</p>",
"descriptionHTML": "<p>Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>You must authenticate using an access\ntoken with the <code>repo</code> scope to use this endpoint. GitHub Apps must have write access to the <code>codespaces_secrets</code>\nrepository permission to use this endpoint.</p>\n<p>This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic\">Managing your personal access tokens</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -206544,7 +206544,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have write access to the <code>codespaces_secrets</code> repository permission to use this endpoint.</p>",
"descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have write access to the <code>codespaces_secrets</code> repository permission to use this endpoint.\nThis endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic\">Managing your personal access tokens</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -247369,7 +247369,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>",
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -247693,7 +247693,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app\">GET an app</a>\".</p>",
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app\">GET an app</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -247855,7 +247855,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>",
"descriptionHTML": "<p>Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -414154,6 +414154,7 @@
"contentType": "application/json",
"description": "<p>Response</p>",
"example": {
"id": "4fd754f7e594640989b406850d0bc8f06a121251",
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status",
"page_url": "developer.github.com"
},
@@ -414162,6 +414163,17 @@
"description": "The GitHub Pages deployment status.",
"type": "object",
"properties": {
"id": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"description": "The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit."
},
"status_url": {
"type": "string",
"description": "The URI to monitor GitHub Pages deployment status.",
@@ -414188,6 +414200,7 @@
}
},
"required": [
"id",
"status_url",
"page_url"
]
@@ -547892,7 +547905,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a <a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">security manager</a>.</p>",
"descriptionHTML": "<p>Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a <a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">security manager</a>, or for repositories owned by enterprise managed users.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

View File

@@ -196333,7 +196333,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>",
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -196657,7 +196657,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app\">GET an app</a>\".</p>",
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app\">GET an app</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -196819,7 +196819,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>",
"descriptionHTML": "<p>Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -362208,7 +362208,7 @@
"contentType": "application/json",
"description": "<p>Response</p>",
"example": {
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status",
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251",
"page_url": "developer.github.com"
},
"schema": {
@@ -362221,7 +362221,7 @@
"description": "The URI to monitor GitHub Pages deployment status.",
"format": "uri",
"examples": [
"https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251"
"https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251"
]
},
"page_url": {

View File

@@ -196398,7 +196398,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>",
"descriptionHTML": "<p>Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -196722,7 +196722,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app\">GET an app</a>\".</p>",
"descriptionHTML": "<p>Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint.</p>\n<p>For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app\">GET an app</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -196884,7 +196884,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/en/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>",
"descriptionHTML": "<p>Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the <code>repo</code> scope. GitHub Apps and fine-grained personal access tokens must have the <code>actions:read</code> permission to use this endpoint. For more information about environments, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -367776,7 +367776,7 @@
"contentType": "application/json",
"description": "<p>Response</p>",
"example": {
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status",
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251",
"page_url": "developer.github.com"
},
"schema": {
@@ -367789,7 +367789,7 @@
"description": "The URI to monitor GitHub Pages deployment status.",
"format": "uri",
"examples": [
"https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251"
"https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251"
]
},
"page_url": {

File diff suppressed because one or more lines are too long

View File

@@ -338305,7 +338305,7 @@
"contentType": "application/json",
"description": "<p>Response</p>",
"example": {
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status",
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251",
"page_url": "developer.github.com"
},
"schema": {
@@ -338318,7 +338318,7 @@
"description": "The URI to monitor GitHub Pages deployment status.",
"format": "uri",
"examples": [
"https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251"
"https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251"
]
},
"page_url": {

View File

@@ -356154,7 +356154,7 @@
"contentType": "application/json",
"description": "<p>Response</p>",
"example": {
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status",
"status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251",
"page_url": "developer.github.com"
},
"schema": {
@@ -356167,7 +356167,7 @@
"description": "The URI to monitor GitHub Pages deployment status.",
"format": "uri",
"examples": [
"https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251"
"https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251"
]
},
"page_url": {

View File

@@ -14,6 +14,9 @@
],
"ghes-3.11": [
"2022-11-28"
],
"ghes-3.12": [
"2022-11-28"
]
},
"versionMapping": {

View File

@@ -9,13 +9,13 @@ export const dates = JSON.parse(await fs.readFile('src/ghes-releases/lib/enterpr
// enterprise-releases/docs/supported-versions.md#release-lifecycle-dates
// Some frontmatter may contain the upcoming GHES release number
export const next = '3.12'
export const nextNext = '3.13'
export const next = '3.13'
export const nextNext = '3.14'
export const supported = ['3.11', '3.10', '3.9', '3.8']
export const supported = ['3.12', '3.11', '3.10', '3.9', '3.8']
// Edit this to `null` when it's no longer the release candidate
export const releaseCandidate = null
export const releaseCandidate = '3.12'
// Ensure that:
// "next" is ahead of "latest" by one minor or major release.

View File

@@ -191029,7 +191029,7 @@
{
"type": "array of strings",
"name": "added",
"description": "<p>An array of files added in the commit.</p>"
"description": "<p>An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "object",
@@ -191112,12 +191112,12 @@
{
"type": "array of strings",
"name": "modified",
"description": "<p>An array of files modified by the commit.</p>"
"description": "<p>An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "array of strings",
"name": "removed",
"description": "<p>An array of files removed in the commit.</p>"
"description": "<p>An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "string",

View File

@@ -177327,7 +177327,7 @@
{
"type": "array of strings",
"name": "added",
"description": "<p>An array of files added in the commit.</p>"
"description": "<p>An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "object",
@@ -177410,12 +177410,12 @@
{
"type": "array of strings",
"name": "modified",
"description": "<p>An array of files modified by the commit.</p>"
"description": "<p>An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "array of strings",
"name": "removed",
"description": "<p>An array of files removed in the commit.</p>"
"description": "<p>An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "string",

View File

@@ -191093,7 +191093,7 @@
{
"type": "array of strings",
"name": "added",
"description": "<p>An array of files added in the commit.</p>"
"description": "<p>An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "object",
@@ -191176,12 +191176,12 @@
{
"type": "array of strings",
"name": "modified",
"description": "<p>An array of files modified by the commit.</p>"
"description": "<p>An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "array of strings",
"name": "removed",
"description": "<p>An array of files removed in the commit.</p>"
"description": "<p>An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "string",

View File

@@ -180594,7 +180594,7 @@
{
"type": "array of strings",
"name": "added",
"description": "<p>An array of files added in the commit.</p>"
"description": "<p>An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "object",
@@ -180677,12 +180677,12 @@
{
"type": "array of strings",
"name": "modified",
"description": "<p>An array of files modified by the commit.</p>"
"description": "<p>An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "array of strings",
"name": "removed",
"description": "<p>An array of files removed in the commit.</p>"
"description": "<p>An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "string",

View File

@@ -180723,7 +180723,7 @@
{
"type": "array of strings",
"name": "added",
"description": "<p>An array of files added in the commit.</p>"
"description": "<p>An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "object",
@@ -180806,12 +180806,12 @@
{
"type": "array of strings",
"name": "modified",
"description": "<p>An array of files modified by the commit.</p>"
"description": "<p>An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "array of strings",
"name": "removed",
"description": "<p>An array of files removed in the commit.</p>"
"description": "<p>An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "string",

File diff suppressed because it is too large Load Diff

View File

@@ -171332,7 +171332,7 @@
{
"type": "array of strings",
"name": "added",
"description": "<p>An array of files added in the commit.</p>"
"description": "<p>An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "object",
@@ -171415,12 +171415,12 @@
{
"type": "array of strings",
"name": "modified",
"description": "<p>An array of files modified by the commit.</p>"
"description": "<p>An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "array of strings",
"name": "removed",
"description": "<p>An array of files removed in the commit.</p>"
"description": "<p>An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "string",

View File

@@ -175346,7 +175346,7 @@
{
"type": "array of strings",
"name": "added",
"description": "<p>An array of files added in the commit.</p>"
"description": "<p>An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "object",
@@ -175429,12 +175429,12 @@
{
"type": "array of strings",
"name": "modified",
"description": "<p>An array of files modified by the commit.</p>"
"description": "<p>An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "array of strings",
"name": "removed",
"description": "<p>An array of files removed in the commit.</p>"
"description": "<p>An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.</p>"
},
{
"type": "string",