Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] main from github:main #416

Merged
merged 43 commits into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
26bd47f
Update OpenAPI Description (#49820)
docs-bot Mar 25, 2024
cf772bc
Merge pull request #32209 from github/repo-sync
docs-bot Mar 25, 2024
629b898
Correct intro, title, and shortTitle in translations (#49828)
peterbe Mar 25, 2024
98e48df
Merge pull request #32210 from github/repo-sync
docs-bot Mar 25, 2024
aa8dfd9
Document usability improvements for cluster HA tooling in GHES 3.12 (…
mattpollard Mar 25, 2024
e86ad10
Merge pull request #32211 from github/repo-sync
docs-bot Mar 25, 2024
aa0884f
Some exception that might not work (#31639)
JJ Mar 25, 2024
b2804a3
Merge pull request #49841 from github/repo-sync
docs-bot Mar 25, 2024
238b547
Fix incorrect DNS record value (#32191)
aspearman Mar 25, 2024
8ab52ef
Merge pull request #49843 from github/repo-sync
docs-bot Mar 25, 2024
d94a9aa
Use "revert" instead of "reverse" in Git context (#32197)
hsnabszhdn Mar 25, 2024
f0fcf07
Node 20.11.1 docker base image upgrade (#49836)
peterbe Mar 25, 2024
97e119f
Merge pull request #49844 from github/repo-sync
docs-bot Mar 25, 2024
a8ef77b
Merge pull request #32212 from github/repo-sync
docs-bot Mar 25, 2024
120bbe1
Use "em dash" instead of "hyphens" to set off end clause (#32198)
hsnabszhdn Mar 25, 2024
eb8ae92
Merge pull request #49847 from github/repo-sync
docs-bot Mar 25, 2024
d506b00
Correct Korean Liquid around variables and reusables (#49829)
peterbe Mar 25, 2024
a3ad060
Merge pull request #32213 from github/repo-sync
docs-bot Mar 25, 2024
cf5700d
Update audit log event data (#49845)
docs-bot Mar 25, 2024
72ad6a3
Use "deselect" instead of "unselecet" for checkboxes (#32199)
hsnabszhdn Mar 25, 2024
2674226
Correct reusables correctly (#49833)
peterbe Mar 25, 2024
724695a
Fix sentence structure in "Backing up a repository" (#32200)
hsnabszhdn Mar 25, 2024
db119d0
Merge pull request #49849 from github/repo-sync
docs-bot Mar 25, 2024
54ffeeb
Merge pull request #32214 from github/repo-sync
docs-bot Mar 25, 2024
244e4cb
Use boldface for clickable UI elements (#32201)
hsnabszhdn Mar 25, 2024
06b2999
Merge pull request #49850 from github/repo-sync
docs-bot Mar 25, 2024
912a5bc
Merge pull request #32215 from github/repo-sync
docs-bot Mar 25, 2024
bfe2e76
Delete orphaned assets (2024-03-25-16-27) (#49846)
docs-bot Mar 25, 2024
fe9ccc1
Documentation for "GitHub Pages bring your own GitHub Actions workflo…
jc-clark Mar 25, 2024
13f716e
docs: Drop agreement on Azure Subscription info (#32204)
gonmmarques Mar 25, 2024
14f9bfe
docs: Add indexing limitation on files with lines over 4096 bytes (#3…
gonmmarques Mar 25, 2024
3835fde
Add autofix coverage information for CodeQL queries (#49781)
max-schaefer Mar 25, 2024
82840f9
Merge pull request #49851 from github/repo-sync
docs-bot Mar 25, 2024
bd399cf
Merge pull request #32216 from github/repo-sync
docs-bot Mar 25, 2024
2ba2fab
Merge pull request #49852 from github/repo-sync
docs-bot Mar 25, 2024
e408ef5
Merge pull request #32217 from github/repo-sync
docs-bot Mar 25, 2024
0b1959a
Use "ID" instead of "id" when in commit context (#32202)
hsnabszhdn Mar 25, 2024
f8a0ade
Merge pull request #49853 from github/repo-sync
docs-bot Mar 25, 2024
41e06e6
Update callouts guidance (#49790)
streats Mar 25, 2024
d569849
Merge pull request #32219 from github/repo-sync
docs-bot Mar 25, 2024
2593210
Include additional information regarding container builds support sco…
corycalahan Mar 25, 2024
9db4384
Update CodeQL CLI manual (#49854)
docs-bot Mar 25, 2024
919a25a
Merge pull request #32220 from github/repo-sync
docs-bot Mar 25, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/actions/install-cocofix/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Install CocoFix

description: Installs the private package `@github/cocofix` from the GitHub Package Registry.

inputs:
token:
description: PAT
required: true

runs:
using: 'composite'
steps:
- name: Install CoCoFix
shell: bash
env:
TOKEN: ${{ inputs.token }}
run: |
npm install --no-save \
'--@github:registry=https://npm.pkg.github.com' \
'--//npm.pkg.github.com/:_authToken=${TOKEN}' \
@github/cocofix
4 changes: 4 additions & 0 deletions .github/workflows/generate-code-scanning-query-lists.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ jobs:
sleep 3
codeql --version

- uses: ./.github/actions/install-cocofix
with:
token: ${{ secrets.DOCS_BOT_PAT_WORKFLOW }}

- name: Build code scanning query list
run: |
for lang in "cpp" "csharp" "go" "java" "javascript" "python" "ruby" "swift"; do
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/lint-code.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,9 @@ jobs:
- name: Run Prettier
run: npm run prettier-check

- uses: ./.github/actions/install-cocofix
with:
token: ${{ secrets.DOCS_BOT_PAT_WORKFLOW }}

- name: Run TypeScript
run: npm run tsc
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# --------------------------------------------------------------------------------
# To update the sha, run `docker pull node:$VERSION-alpine`
# look for something like: `Digest: sha256:0123456789abcdef`
FROM node:20-alpine@sha256:c0a3badbd8a0a760de903e00cedbca94588e609299820557e72cba2a53dbaa2c as base
FROM node:20-alpine@sha256:bf77dc26e48ea95fca9d1aceb5acfa69d2e546b765ec2abfb502975f1a2d4def as base

# This directory is owned by the node user
ARG APP_HOME=/home/node/app
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ On the "Notification settings" page, select "Email" or "Web" notifications. Opti

## Organization alerts notification options

If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", unselect **Email**.
If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", deselect **Email**.

## Managing your notification settings with {% data variables.product.prodname_mobile %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If your support request is outside of the scope of what our team can help you wi

- The legacy community-maintained version of ARC
- Template spec customization
- Container orchestration, such as Kubernetes setup, networking, etc.
- Container orchestration, such as Kubernetes setup, networking, building images in ARC (DinD), etc.
- Applying Kubernetes policies
- Managed Kubernetes providers or provider-specific configurations
- [Runner Container Hooks](https://github.com/actions/runner-container-hooks) in conjunction with ARC's `kubernetes` mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -664,38 +664,23 @@ $ ghe-cluster-maintenance -u
# Unsets maintenance mode
```

{% ifversion cluster-node-removal %}

### ghe-remove-node
{% ifversion cluster-ha-tooling-improvements %}

This utility removes a node from a cluster. If you're replacing a node, after you've set up a replacement node, you can use this command to take the old node offline. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node)."
### ghe-cluster-repl-bootstrap

You must run this command from the primary MySQL node in your cluster, which is typically the node designated as `mysql-master` in your cluster configuration file (`cluster.conf`). You can use this command to remove any node, with the exception of the `mysql-master` or `redis-master` node. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/initializing-the-cluster#about-the-cluster-configuration-file)."
This utility configures high availability replication to a secondary set of cluster nodes. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/configuring-high-availability-replication-for-a-cluster)."

```shell
ghe-remove-node HOSTNAME
ghe-cluster-repl-bootstrap
```

The command does the following things:
- Evacuates data from any data services running on the node, so that the remaining nodes in your cluster contain copies of the data
- Marks the node as offline in your configuration, applies this change to the rest of the nodes in the cluster, and stops traffic being routed to the node

You can run the command with the following flags.
### ghe-cluster-repl-teardown

Flag | Description
---- | ----------
`-ne/--no-evacuate` | Skips evacuation of data services (warning: may result in data loss).
`-v/--verbose` | Prints additional information to the console.
`-h/--help` | Displays help text for the command.
This utility disables replication to replica nodes for a cluster in a high availability configuration. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/configuring-high-availability-replication-for-a-cluster#disabling-high-availability-replication-for-a-cluster)."

{% note %}

**Notes:**

- This command can only be used to remove a node from a cluster configuration. It cannot be used to remove a node from a high availability configuration.
- This command does not support parallel execution. To remove multiple nodes, you must wait until this command has finished before running it for another node.

{% endnote %}
```shell
ghe-cluster-repl-teardown
```

{% endif %}

Expand Down Expand Up @@ -763,6 +748,41 @@ To evacuate a {% data variables.product.prodname_pages %} storage service before
ghe-dpages evacuate pages-server-UUID
```

{% ifversion cluster-node-removal %}

### ghe-remove-node

This utility removes a node from a cluster. If you're replacing a node, after you've set up a replacement node, you can use this command to take the old node offline. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node)."

You must run this command from the primary MySQL node in your cluster, which is typically the node designated as `mysql-master` in your cluster configuration file (`cluster.conf`). You can use this command to remove any node, with the exception of the `mysql-master` or `redis-master` node. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/initializing-the-cluster#about-the-cluster-configuration-file)."

```shell
ghe-remove-node HOSTNAME
```

The command does the following things:
- Evacuates data from any data services running on the node, so that the remaining nodes in your cluster contain copies of the data
- Marks the node as offline in your configuration, applies this change to the rest of the nodes in the cluster, and stops traffic being routed to the node

You can run the command with the following flags.

Flag | Description
---- | ----------
`-ne/--no-evacuate` | Skips evacuation of data services (warning: may result in data loss).
`-v/--verbose` | Prints additional information to the console.
`-h/--help` | Displays help text for the command.

{% note %}

**Notes:**

- This command can only be used to remove a node from a cluster configuration. It cannot be used to remove a node from a high availability configuration.
- This command does not support parallel execution. To remove multiple nodes, you must wait until this command has finished before running it for another node.

{% endnote %}

{% endif %}

{% ifversion ghe-spokes-deprecation-phase-1 %}

### ghe-spokesctl
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ To migrate your enterprise from SAML to OIDC, you will disable your existing {%
{% data reusables.emus.use-enterprise-recovery-code %}
{% data reusables.enterprise-accounts.security-tab %}
1. At the bottom of the page, next to "Migrate to OpenID Connect single sign-on", click **Configure with Azure**.
1. Read the warning, then click "I understand, begin migrating to OpenID Connect".
1. Read the warning, then click **I understand, begin migrating to OpenID Connect**.
{% data reusables.enterprise-accounts.emu-azure-admin-consent %}
1. After you grant consent, a new browser window will open to {% data variables.location.product_location %} and display a new set of recovery codes for your {% data variables.enterprise.prodname_emu_enterprise %}. Download the codes, then click "Enable OIDC authentication".
1. After you grant consent, a new browser window will open to {% data variables.location.product_location %} and display a new set of recovery codes for your {% data variables.enterprise.prodname_emu_enterprise %}. Download the codes, then click **Enable OIDC authentication**.
1. Wait for the migration to complete, which can take up to an hour. To check the status of the migration, navigate to your enterprise's authentication security settings page. If "Require SAML authentication" is selected, the migration is still in progress.

{% warning %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,38 @@ You must assign a static IP address to each new node that you provision, and you

## Creating a high availability replica for a cluster

- [Assigning active nodes to the primary datacenter](#assigning-active-nodes-to-the-primary-datacenter)
- [Adding replica nodes to the cluster configuration file](#adding-replica-nodes-to-the-cluster-configuration-file)
- [Example configuration](#example-configuration)
{% ifversion cluster-ha-tooling-improvements %}

### Assigning active nodes to the primary datacenter
To create a high availability replica for your cluster, use the `ghe-cluster-repl-bootstrap` utility, then complete the follow-up tasks that the tool details.

{% data reusables.enterprise_clustering.ssh-to-a-node %}
1. To begin configuration of high availability, run the following command. The `-p` and `-s` flags are optional. If you're using the flags, replace PRIMARY-DATACENTER and SECONDARY-DATACENTER with the names of your primary and secondary datacenters.

{% note %}

**Notes:**

- By default, the utility will use the name of the primary datacenter in `cluster.conf`.
- If no name for the primary datacenter is defined, the utility will use `mona`.
- If no name for the secondary datacenter is defined, the utility will use `hubot`.

{% endnote %}

```shell copy
ghe-cluster-repl-bootstrap -p PRIMARY-DATACENTER -s SECONDARY-DATACENTER
```

1. After the utility runs, you will see output with further instructions. To finish the configuration, complete the tasks listed in the output.

{% else %}

To create a high availability replica for your cluster, you must complete the following tasks. You can also review an example configuration.

1. [Assign active nodes to the primary datacenter](#1-assign-active-nodes-to-the-primary-datacenter).
1. [Add replica nodes to the cluster configuration file](#2-add-replica-nodes-to-the-cluster-configuration-file).
1. [Review an example configuration](#3-review-an-example-configuration).

### 1. Assign active nodes to the primary datacenter

Before you define a secondary datacenter for your replica nodes, ensure that you assign your active nodes to the primary datacenter.

Expand Down Expand Up @@ -100,7 +127,7 @@ Before you define a secondary datacenter for your replica nodes, ensure that you

After {% data variables.product.prodname_ghe_server %} returns you to the prompt, you've finished assigning your nodes to the cluster's primary datacenter.

### Adding replica nodes to the cluster configuration file
### 2. Add replica nodes to the cluster configuration file

To configure high availability, you must define a corresponding replica node for every active node in your cluster. To create a new cluster configuration that defines both active and replica nodes, you'll complete the following tasks.

Expand Down Expand Up @@ -231,7 +258,7 @@ For an example configuration, see "[Example configuration](#example-configuratio

You've finished configuring high availability replication for the nodes in your cluster. Each active node begins replicating configuration and data to its corresponding replica node, and you can direct traffic to the load balancer for the secondary datacenter in the event of a failure. For more information about failing over, see "[AUTOTITLE](/enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster)."

### Example configuration
### 3. Review an example configuration

The top-level `[cluster]` configuration should look like the following example.

Expand Down Expand Up @@ -295,6 +322,8 @@ The configuration for the corresponding replica node in the storage tier should
...
```

{% endif %}

## Monitoring replication between active and replica cluster nodes

Initial replication between the active and replica nodes in your cluster takes time. The amount of time depends on the amount of data to replicate and the activity levels for {% data variables.product.prodname_ghe_server %}.
Expand Down Expand Up @@ -322,13 +351,28 @@ If you use the original active nodes, after reconfiguring high availability, you

## Disabling high availability replication for a cluster

You can stop replication to the replica nodes for your cluster deployment of {% data variables.product.prodname_ghe_server %}.
You can stop replication to the replica nodes for your cluster deployment of {% data variables.product.prodname_ghe_server %}{% ifversion cluster-ha-tooling-improvements %} using the `ghe-cluster-repl-teardown` utility. Alternatively, you can manually disable replication.{% else %}.{% endif %}

{% ifversion cluster-ha-tooling-improvements %}

### Disabling replication using `ghe-cluster-repl-teardown`

{% data reusables.enterprise_clustering.ssh-to-a-node %}
1. To disable replication, run the following command:

```shell copy
ghe-cluster-repl-teardown
```

{% data reusables.enterprise_clustering.configuration-finished %}

### Manually disabling replication

{% endif %}

{% data reusables.enterprise_clustering.ssh-to-a-node %}
{% data reusables.enterprise_clustering.open-configuration-file %}
1. In the top-level `[cluster]` section, delete the `redis-master-replica`, and `mysql-master-replica` key-value pairs.
1. Delete each section for a replica node. For replica nodes, `replica` is configured as `enabled`.
{% data reusables.enterprise_clustering.apply-configuration %}
{% data reusables.enterprise_clustering.configuration-finished %}

After {% data variables.product.prodname_ghe_server %} returns you to the prompt, you've finished disabling high availability replication.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Connecting an Azure subscription
intro: "If you use {% data variables.product.product_name %} through a Microsoft Enterprise Agreement, you can enable and pay for usage-based billing on {% data variables.location.product_location %} by connecting an Azure subscription."
intro: "You can enable and pay for usage-based billing on {% data variables.location.product_location %} by connecting an Azure subscription."
redirect_from:
- /github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account/connecting-an-azure-subscription-to-your-enterprise
- /github/setting-up-and-managing-billing-and-payments-on-github/connecting-an-azure-subscription-to-your-enterprise
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,8 @@ The build mode that will be used to create the database.
Choose your build mode based on the language you are analyzing:

`none`: The database will be created without building the source root.
Available for JavaScript/TypeScript, Python, Ruby.
Available for JavaScript/TypeScript, Python, and Ruby. Also available in
beta for Java.

`autobuild`: The database will be created by attempting to automatically
build the source root. Available for C/C++, C#, Go, Java/Kotlin, and
Expand All @@ -105,7 +106,7 @@ a manually specified build command. Available for C/C++, C#, Go,
Java/Kotlin, and Swift.

When creating a database with `--command`, there is no need to
additionally specify '--build-mode none'.
additionally specify '--build-mode manual'.

Available since `v2.16.4`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ The build mode that will be used to create the database.
Choose your build mode based on the language you are analyzing:

`none`: The database will be created without building the source root.
Available for JavaScript/TypeScript, Python, Ruby.
Available for JavaScript/TypeScript, Python, and Ruby. Also available in
beta for Java.

`autobuild`: The database will be created by attempting to automatically
build the source root. Available for C/C++, C#, Go, Java/Kotlin, and
Expand All @@ -118,7 +119,7 @@ a manually specified build command. Available for C/C++, C#, Go,
Java/Kotlin, and Swift.

When creating a database with `--command`, there is no need to
additionally specify '--build-mode none'.
additionally specify '--build-mode manual'.

Available since `v2.16.4`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ shortTitle: Change access permissions

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
1. Under Features, unselect **Restrict editing to collaborators only**.
1. Under Features, deselect **Restrict editing to collaborators only**.

## Further reading

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When you turn off a wiki, the content is hidden, but not erased. If you choose t

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
1. Under Features, unselect **Wikis**.
1. Under Features, deselect **Wikis**.

## Further reading

Expand Down
Loading