Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4fc4e97

Browse files
rachaelrenkisaacmbrownguntripfelicitymaydocs-bot
authored
Enable GitHub Enterprise Server 3.13 release candidate on GitHub Docs (#50165)
Co-authored-by: Isaac Brown <[email protected]> Co-authored-by: Steve Guntrip <[email protected]> Co-authored-by: Felicity Chapman <[email protected]> Co-authored-by: isaacmbrown <[email protected]> Co-authored-by: docs-bot <[email protected]> Co-authored-by: Peter Bengtsson <[email protected]> Co-authored-by: Pallavi <[email protected]>
1 parent c6e1cef commit 4fc4e97

61 files changed

Lines changed: 901349 additions & 57 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/admin/all-releases.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ If you run analysis in an external CI system, we recommend using the same versio
5252

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

6768
| {% data variables.product.product_name %} version | Minimum Runner version |
6869
| ------------------------------------------------- | ---------------------- |
70+
| 3.13 | 2.314.1 ([release notes](https://github.com/actions/runner/releases/tag/v2.314.1)) |
6971
| 3.12 | 2.311.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.311.0)) |
7072
| 3.11 | 2.309.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.309.0)) |
7173
| 3.10 | 2.304.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.304.0)) |

‎content/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/upgrading-a-cluster.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,13 @@ Use an upgrade package to upgrade a {% data variables.product.prodname_ghe_serve
6767
### Upgrading the cluster nodes
6868

6969
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`.
70+
{% ifversion ghes > 3.10 and ghes < 3.15 %}
71+
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)."
72+
73+
Before upgrading, you will need to run a script to prepare your cluster for an upgrade to 3.13 or 3.14.
74+
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.
75+
1. On any `elasticsearch-server` node, run `/usr/local/share/enterprise/ghe-es-auditlog-cluster-rebalance`.
76+
{% endif %}
7077
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.
7178
Run the `ghe-upgrade` command, providing the package file name you downloaded in Step 4 of [Preparing to upgrade](#preparing-to-upgrade):
7279

‎content/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ children:
1818
- /increasing-storage-capacity
1919
- /increasing-cpu-or-memory-resources
2020
- /migrating-from-github-enterprise-1110x-to-2123
21+
- /preparing-for-the-elasticsearch-upgrade
2122
- /known-issues-with-upgrades-to-your-instance
2223
shortTitle: Update VM & resources
2324
---

‎content/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/preparing-for-the-elasticsearch-upgrade.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Preparing for the Elasticsearch upgrade in {% data variables.product.prodname_ghe_server %} 3.13
3+
intro: 'As part of upgrading {% data variables.product.prodname_ghe_server %} to version 3.13 or later, the Elasticsearch service will be upgraded.'
4+
versions:
5+
ghes: '>3.10 <3.15'
6+
type: reference
7+
topics:
8+
- Enterprise
9+
- Upgrades
10+
shortTitle: Elasticsearch upgrade in 3.13
11+
allowTitleToDifferFromFilename: true
12+
---
13+
14+
## Overview
15+
16+
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.
17+
18+
The following sections help administrators prepare for and monitor the Elasticsearch upgrade. The key points are:
19+
20+
- The upgrade will temporarily degrade the experience of the search and audit log features.
21+
- 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)."
22+
- For backups, all customers should take a snapshot of their instance when the upgrade is complete.
23+
24+
## Impact on search and audit logs
25+
26+
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.
27+
28+
Audit logs will not be available immediately after upgrade, and it may take several hours to migrate all audit logs.
29+
30+
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.
31+
32+
## Monitoring the Elasticsearch upgrade
33+
34+
You can monitor the progress of the ES upgrade in the site admin dashboard.
35+
36+
1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}.
37+
1. In the left sidebar, click **Search indexes**.
38+
39+
When the index rebuild is complete, all the search indexes should show green and "100%."
40+
41+
## Changing the number of repair workers
42+
43+
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.
44+
45+
{% data reusables.enterprise_installation.ssh-into-instance %}
46+
1. To change the number of workers, enter the following command.
47+
48+
```shell copy
49+
ghe-config app.github.es-workers NUMBER-OF-WORKERS
50+
```
51+
52+
1. Run `ghe-config-apply`.
53+
54+
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.

‎content/get-started/accessibility/keyboard-shortcuts.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
8585
|<kbd>a</kbd> | Show or hide annotations on diffs
8686
|<kbd>b</kbd> | Open blame view. For more information, see "[AUTOTITLE](/repositories/working-with-files/using-files/viewing-a-file)."
8787

88-
{% ifversion code-search-code-view %}
88+
{% ifversion code-view-ui %}
8989

9090
## Navigating within code files
9191

@@ -95,7 +95,10 @@ If you view a code file in a repository using the **Code** view and click on any
9595
|-----------|------------
9696
|<kbd>Shift</kbd>+<kbd>J</kbd>| Highlights the line that is currently selected by the cursor within the code file
9797
|<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
98+
| {% ifversion code-search-upgrade %} |
9899
|<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
100+
| {% endif %} |
101+
99102
{% endif %}
100103

101104
## Comments

‎content/get-started/learning-about-github/github-language-support.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ redirect_from:
1515

1616
## About supported languages
1717

18-
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)."
18+
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)."
1919

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

‎content/get-started/start-your-journey/hello-world.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ You can make and save changes to the files in your repository. On {% data variab
9696
1. Under the `readme-edits` branch you created, click the `README.md` file.
9797
1. To edit the file, click {% octicon "pencil" aria-label="Edit file" %}.
9898
1. In the editor, write a bit about yourself.
99-
{% ifversion code-search-code-view %}1. Click **Commit changes...**.{% endif %}
99+
{% ifversion code-view-ui %}1. Click **Commit changes...**.{% endif %}
100100
1. In the "Commit changes" box, write a commit message that describes your changes.
101101
1. Click **Commit changes**.
102102

‎content/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Custom property names and values may only contain certain characters:
2828

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

31-
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)."
31+
{% 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 %}
3232

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

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

63-
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)."
63+
{% 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 %}
6464

6565
{% data reusables.repositories.navigate-to-repo %}
6666
{% data reusables.repositories.sidebar-settings %}

‎content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ You can create a branch in different ways on {% data variables.product.product_n
4444
### Creating a branch using the branch dropdown
4545

4646
{% data reusables.repositories.navigate-to-repo %}
47-
{% ifversion code-search-code-view %}
47+
{% ifversion code-view-ui %}
4848
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.
4949

5050
![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)

‎content/repositories/working-with-files/managing-files/creating-new-files.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ When creating a file on {% data variables.product.product_name %}, consider the
2828
1. In the file name field, type the name and extension for the file. To create subdirectories, type the `/` directory separator.
2929
1. In the file contents text box, type content for the file.
3030
1. To review the new content, above the file contents, click **Preview**.
31-
{% ifversion code-search-code-view %}
31+
{% ifversion code-view-ui %}
3232
![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)
3333
{% else %}
3434
![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)

0 commit comments

Comments
 (0)