Skip to content

Commit

Permalink
Merge pull request #32996 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored May 16, 2024
2 parents 4438a17 + effb2d7 commit 22e3d9c
Show file tree
Hide file tree
Showing 64 changed files with 901,349 additions and 139 deletions.
2 changes: 2 additions & 0 deletions content/admin/all-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ If you run analysis in an external CI system, we recommend using the same versio

| {% data variables.product.product_name %} version | Recommended {% data variables.product.prodname_codeql_cli %} version |
| ------------------------------------------------- | ---------------------- |
| 3.13 | 2.16.6 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.16.6/)) |
| 3.12 | 2.15.5 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.15.5/)) |
| 3.11 | 2.14.6 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.14.6/)) |
| 3.10 | 2.13.5 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.13.5/)) |
Expand All @@ -66,6 +67,7 @@ For instances with {% data variables.product.prodname_actions %} enabled, self-h

| {% data variables.product.product_name %} version | Minimum Runner version |
| ------------------------------------------------- | ---------------------- |
| 3.13 | 2.314.1 ([release notes](https://github.com/actions/runner/releases/tag/v2.314.1)) |
| 3.12 | 2.311.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.311.0)) |
| 3.11 | 2.309.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.309.0)) |
| 3.10 | 2.304.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.304.0)) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,13 @@ Use an upgrade package to upgrade a {% data variables.product.prodname_ghe_serve
### Upgrading the cluster nodes

1. Enable maintenance mode according to your scheduled window by connecting to the administrative shell of any cluster node and running `ghe-cluster-maintenance -s`.
{% ifversion ghes > 3.10 and ghes < 3.15 %}
1. If you're upgrading from version 3.11 or 3.12 to version 3.13 or later, Elasticsearch will be upgraded as part of the upgrade to your cluster. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/preparing-for-the-elasticsearch-upgrade)."

Before upgrading, you will need to run a script to prepare your cluster for an upgrade to 3.13 or 3.14.
1. Ensure you are running the required patch release for your current version: **3.11.9** or later for 3.11, or **3.12.3** or later for 3.12.
1. On any `elasticsearch-server` node, run `/usr/local/share/enterprise/ghe-es-auditlog-cluster-rebalance`.
{% endif %}
1. **With the exception of the primary MySQL node**, connect to the administrative shell of each of the {% data variables.product.prodname_ghe_server %} nodes.
Run the `ghe-upgrade` command, providing the package file name you downloaded in Step 4 of [Preparing to upgrade](#preparing-to-upgrade):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ children:
- /increasing-storage-capacity
- /increasing-cpu-or-memory-resources
- /migrating-from-github-enterprise-1110x-to-2123
- /preparing-for-the-elasticsearch-upgrade
- /known-issues-with-upgrades-to-your-instance
shortTitle: Update VM & resources
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Preparing for the Elasticsearch upgrade in {% data variables.product.prodname_ghe_server %} 3.13
intro: 'As part of upgrading {% data variables.product.prodname_ghe_server %} to version 3.13 or later, the Elasticsearch service will be upgraded.'
versions:
ghes: '>3.10 <3.15'
type: reference
topics:
- Enterprise
- Upgrades
shortTitle: Elasticsearch upgrade in 3.13
allowTitleToDifferFromFilename: true
---

## Overview

Elasticsearch (ES) powers the search functionality on your {% data variables.product.prodname_ghe_server %} instance. To bring the benefits of better performance and security posture, when you upgrade your instance to version 3.13 or later, the Elasticsearch version in the appliance will be upgraded from 5.6.16 to 8.7.0.

The following sections help administrators prepare for and monitor the Elasticsearch upgrade. The key points are:

- The upgrade will temporarily degrade the experience of the search and audit log features.
- If you're upgrading an instance in a cluster configuration, you must run a script to prepare your cluster for the ES upgrade. See "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/upgrading-a-cluster#upgrading-the-cluster-nodes)."
- For backups, all customers should take a snapshot of their instance when the upgrade is complete.

## Impact on search and audit logs

All search indexes will be rebuilt after the upgrade to ES8. Users will experience degraded search experience during the rebuild, but the instance is otherwise expected to be functional and available. The index rebuild process depends on the size of the data set and may take a few hours to days.

Audit logs will not be available immediately after upgrade, and it may take several hours to migrate all audit logs.

We strongly recommend you take a backup (using backup-utils) immediately following completion of the index rebuild and use that snapshot for all future restores. See "[AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance)." If you restore a backup from an instance running {% data variables.product.prodname_ghe_server %} 3.11 or 3.12, then any content that relies on ES will only be available after the ES indexes have been migrated and rebuilt on the 3.13 instance.

## Monitoring the Elasticsearch upgrade

You can monitor the progress of the ES upgrade in the site admin dashboard.

1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}.
1. In the left sidebar, click **Search indexes**.

When the index rebuild is complete, all the search indexes should show green and "100%."

## Changing the number of repair workers

By default, the number of index repair workers is set to the number of CPU cores divided by 8 (with an upper bound of 8). To speed up the index rebuild, you can adjust the worker count. However, before doing so, you should consider the potential impact to the load.

{% data reusables.enterprise_installation.ssh-into-instance %}
1. To change the number of workers, enter the following command.

```shell copy
ghe-config app.github.es-workers NUMBER-OF-WORKERS
```

1. Run `ghe-config-apply`.

You can also adjust the worker count for individual index rebuilds in the "Search Indexes" section of the site admin dashboard. See the "[Monitoring the Elasticsearch upgrade](#monitoring-the-elasticsearch-upgrade)" section.
5 changes: 4 additions & 1 deletion content/get-started/accessibility/keyboard-shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>a</kbd> | Show or hide annotations on diffs
|<kbd>b</kbd> | Open blame view. For more information, see "[AUTOTITLE](/repositories/working-with-files/using-files/viewing-a-file)."

{% ifversion code-search-code-view %}
{% ifversion code-view-ui %}

## Navigating within code files

Expand All @@ -95,7 +95,10 @@ If you view a code file in a repository using the **Code** view and click on any
|-----------|------------
|<kbd>Shift</kbd>+<kbd>J</kbd>| Highlights the line that is currently selected by the cursor within the code file
|<kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>C</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>C</kbd> (Windows/Linux) | If a line of code is currently selected, this shortcut opens the line menu for that line, appearing under {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} to the left of the line
| {% ifversion code-search-upgrade %} |
|<kbd>Command</kbd>+<kbd>Enter</kbd> (Mac) or </br> <kbd>Control</kbd>+<kbd>Enter</kbd> (Windows/Linux) | Highlights the code symbol currently selected by the cursor and all other occurrences of the symbol in the code, and shows the symbol in the symbols pane
| {% endif %} |

{% endif %}

## Comments
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ redirect_from:

## About supported languages

Most {% data variables.product.prodname_dotcom %} features work regardless of which languages your code is written in. You can search for code or enable syntax highlighting based on any language known to {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE]{% ifversion code-search-code-view %}(/search-github/github-code-search/understanding-github-code-search-syntax#language-qualifier){% else %}(/search-github/searching-on-github/searching-code#search-by-language){% endif %}" or "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting)."
Most {% data variables.product.prodname_dotcom %} features work regardless of which languages your code is written in. You can search for code or enable syntax highlighting based on any language known to {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/understanding-github-code-search-syntax#language-qualifier){% else %}(/search-github/searching-on-github/searching-code#search-by-language){% endif %}" or "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting)."

Some {% data variables.product.prodname_dotcom %} products have features that are currently only supported for a subset of programming languages.

Expand Down
2 changes: 1 addition & 1 deletion content/get-started/start-your-journey/hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ You can make and save changes to the files in your repository. On {% data variab
1. Under the `readme-edits` branch you created, click the `README.md` file.
1. To edit the file, click {% octicon "pencil" aria-label="Edit file" %}.
1. In the editor, write a bit about yourself.
{% ifversion code-search-code-view %}1. Click **Commit changes...**.{% endif %}
{% ifversion code-view-ui %}1. Click **Commit changes...**.{% endif %}
1. In the "Commit changes" box, write a commit message that describes your changes.
1. Click **Commit changes**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Custom property names and values may only contain certain characters:

You can add custom properties to your organization and set values for those properties for repositories in your organization.

You can also use the REST API to create and manage custom properties for an organization. For more information, see "[AUTOTITLE](/rest/orgs/custom-properties)."
{% ifversion ghec %}You can also use the REST API to create and manage custom properties for an organization. For more information, see "[AUTOTITLE](/rest/orgs/custom-properties)."{% endif %}

{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}
Expand Down Expand Up @@ -60,7 +60,7 @@ You can set values for custom properties for repositories in your organization.

People with read permissions to a repository can view the values of custom properties for that repository, but they can't edit those values.

You can also use the REST API to list the custom properties assigned to a repository by your organization. For more information, see "[AUTOTITLE](/rest/repos/custom-properties)."
{% ifversion ghec %}You can also use the REST API to list the custom properties assigned to a repository by your organization. For more information, see "[AUTOTITLE](/rest/repos/custom-properties)."{% endif %}

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You can create a branch in different ways on {% data variables.product.product_n
### Creating a branch using the branch dropdown

{% data reusables.repositories.navigate-to-repo %}
{% ifversion code-search-code-view %}
{% ifversion code-view-ui %}
1. Select the {% octicon "git-branch" aria-hidden="true" %} branch dropdown menu, in the file tree view or at the top of the integrated file editor.

![Screenshot of the file tree view for a repository. A dropdown menu for branches is outlined in dark orange.](/assets/images/help/branches/file-tree-view-branch-dropdown.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ When creating a file on {% data variables.product.product_name %}, consider the
1. In the file name field, type the name and extension for the file. To create subdirectories, type the `/` directory separator.
1. In the file contents text box, type content for the file.
1. To review the new content, above the file contents, click **Preview**.
{% ifversion code-search-code-view %}
{% ifversion code-view-ui %}
![Screenshot of a file in edit mode. Above the text box for editing file contents, a tab, labeled "Preview", outlined in dark orange.](/assets/images/help/repository/new-file-preview.png)
{% else %}
![Screenshot of a file in edit mode. Above the text box for editing file contents, a tab, labeled "Preview", outlined in dark orange.](/assets/images/enterprise/repository/new-file-preview.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If the file or directory you deleted contains sensitive data, the data will stil
## Deleting a file

1. Browse to the file in your repository that you want to delete.
{% ifversion code-search-code-view %}
{% ifversion code-view-ui %}
1. In the top-right corner, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} dropdown menu, then click **Delete file**.

![Screenshot of the file list for a directory. To the right of the directory name, a button, labeled with a kebab icon, is outlined in dark orange.](/assets/images/help/repository/delete-file-button.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ To learn more about these approaches, see "[Precise and search-based navigation]

Future releases will add _precise code navigation_ for more languages, which is a code navigation approach that can give more accurate results.

{% ifversion code-search-code-view %}You can use keyboard shortcuts to navigate within a code file. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#navigating-within-code-files)."{% endif %}
{% ifversion code-view-ui %}You can use keyboard shortcuts to navigate within a code file. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#navigating-within-code-files)."{% endif %}

{% ifversion code-search-code-view %}
{% ifversion code-search-upgrade %}

## Using the symbols pane

Expand Down Expand Up @@ -109,4 +109,4 @@ If code navigation is enabled for you but you don't see links to the definitions

## Further reading

- "[AUTOTITLE]{% ifversion code-search-code-view %}(/search-github/github-code-search/about-github-code-search){% else %}(/search-github/searching-on-github/searching-code){% endif %}"
- "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/about-github-code-search){% else %}(/search-github/searching-on-github/searching-code){% endif %}"
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ With the raw view, you can view or copy the raw content of a file without any st
{% data reusables.repositories.navigate-to-repo %}
1. Click the file that you want to view.
1. In the upper-right corner of the file view, click **Raw**.
{% ifversion code-search-code-view %}
{% ifversion code-view-ui %}

![Screenshot of a file. In the header, a button, labeled "Raw," outlined in dark orange.](/assets/images/help/repository/raw-file-button.png)
{% else %}

![Screenshot of a file. In the header, a button, labeled "Raw," outlined in dark orange.](/assets/images/enterprise/repository/raw-file-button.png)
{% endif %}
1. Optionally, to copy the raw file content, in the upper-right corner of the file view, click **{% octicon "copy" aria-label="Copy raw content" %}**. {% ifversion code-search-code-view %} To download the raw file, click **{% octicon "download" aria-label="Download raw file" %}**.{% endif %}
1. Optionally, to copy the raw file content, in the upper-right corner of the file view, click **{% octicon "copy" aria-label="Copy raw content" %}**. {% ifversion code-view-ui %} To download the raw file, click **{% octicon "download" aria-label="Download raw file" %}**.{% endif %}

## Viewing the line-by-line revision history for a file

Expand All @@ -44,7 +44,7 @@ Within the blame view, you can view the line-by-line revision history for an ent

{% data reusables.repositories.navigate-to-repo %}
1. Click to open the file whose line history you want to view.
{% ifversion code-search-code-view %}
{% ifversion code-view-ui %}
1. Above the file content, click **Blame**. This view gives you a line-by-line revision history, with the code in a file separated by commit. Each commit lists the author, commit description, and commit date.
1. To see versions of a file before a particular commit, click {% octicon "versions" aria-label="View blame prior to this change" %}. Alternatively, to see more detail about a particular commit, click the commit message.

Expand Down
26 changes: 24 additions & 2 deletions content/rest/enterprise-admin/management-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,31 @@ topics:
autogenerated: rest
---

## About the {% data variables.enterprise.management_console %}
## Deprecation of the Management Console endpoints

The full functionality of the Management Console endpoints was added to the [Manage GHES](/rest/enterprise-admin/manage-ghes) endpoints in {% data variables.product.prodname_ghe_server %} version 3.12. With feature parity achieved, the Management Console API endpoints {% ifversion ghes < 3.14 %}will be{% else %}were{% endif %} deprecated in version 3.14.

{% ifversion management-console-manage-ghes-parity %}

To help you migrate, the mapping table below shows the equivalent Manage GHES operation for each Management Console operation.{% ifversion ghes < 3.14 %} Please migrate to the Manage GHES API endpoints as soon as possible.{% endif %}

{% data reusables.enterprise_management_console.api-deprecation %}
| Purpose | Management Console API operation | Manage GHES API operation |
| ------------- | ------------- | - |
| Get the configuration status | `GET /setup/api/configcheck` | [`GET /manage/v1/config/apply`](/rest/enterprise-admin/manage-ghes#get-the-status-of-a-ghe-config-apply-run) |
| Start a configuration process | `POST /setup/api/configure` | [`POST /manage/v1/config/apply`](/rest/enterprise-admin/manage-ghes#trigger-a-ghe-config-apply-run) |
| Get the maintenance status | `GET /setup/api/maintenance` | [`GET /manage/v1/maintenance`](/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode) |
| Enable or disable maintenance mode | `POST /setup/api/maintenance` | [`POST /manage/v1/maintenance`](/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode) |
| Get settings | `GET /setup/api/settings` | [`GET /manage/v1/config/settings`](/rest/enterprise-admin/manage-ghes#get-the-ghes-settings) |
| Set settings | `PUT /setup/api/settings` | [`PUT /manage/v1/config/settings`](/rest/enterprise-admin/manage-ghes#set-settings) |
| Get all authorized SSH keys | `GET /setup/api/settings/authorized-keys` | [`GET /manage/v1/access/ssh`](/rest/enterprise-admin/manage-ghes#get-the-configured-ssh-keys) |
| Add an authorized SSH key | `POST /setup/api/settings/authorized-keys` | [`POST /manage/v1/access/ssh`](/rest/enterprise-admin/manage-ghes#set-a-new-ssh-key) |
| Remove an authorized SSH key | `DELETE /setup/api/settings/authorized-keys` | [`DELETE /manage/v1/access/ssh`](/rest/enterprise-admin/manage-ghes#delete-a-ssh-key) |
| Create a GitHub license | `POST /setup/api/start` | [`POST /manage/v1/config/init`](/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload) |
| Upgrade a license | `POST /setup/api/upgrade` | [`PUT /manage/v1/config/license`](/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license) |

{% endif %}

## About the {% data variables.enterprise.management_console %}

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`.

Expand Down
3 changes: 2 additions & 1 deletion content/rest/orgs/organization-roles.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: REST API endpoints for organization roles
shortTitle: Organization roles
intro: 'Use the REST API to interact with organization roles.'
intro: Use the REST API to interact with organization roles.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
ghes: '>=3.13'
topics:
- API
autogenerated: rest
Expand Down
Loading

0 comments on commit 22e3d9c

Please sign in to comment.