Skip to content

repo sync #20477

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.

Sign up for GitHub

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

Merged
Octomerger merged 2 commits into from
Sep 8, 2022
Merged

repo sync #20477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3303a2
Add a section about upgrading GitHub Enterprise Backup Utilities (#28…
vgrl Sep 7, 2022
2144d47
Update OpenAPI Descriptions (#30603)
github-openapi-bot Sep 8, 2022
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
159 changes: 134 additions & 25 deletions ...figuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md
View file
Open in desktop

Large diffs are not rendered by default.

11 changes: 9 additions & 2 deletions ...he-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,15 @@ shortTitle: Upgrading GHES

## Preparing to upgrade

1. Determine an upgrade strategy and choose a version to upgrade to. For more information, see "[Upgrade requirements](/enterprise/admin/guides/installation/upgrade-requirements/)" and refer to the [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) to find the upgrade path from your current release version.
1. Create a fresh backup of your primary instance with the {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README.md file](https://github.com/github/backup-utils#readme).
1. Determine an upgrade strategy and choose a version to upgrade to. For more information, see "[Upgrade requirements](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrade-requirements/)" and refer to the [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) to find the upgrade path from your current release version.
1. Create a fresh backup of your primary instance with the {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see the [README.md file](https://github.com/github/backup-utils#readme) in the {% data variables.product.prodname_enterprise_backup_utilities %} project documentation.

{% note %}

**Note:** Your {% data variables.product.prodname_enterprise_backup_utilities %} version needs to be the same version as, or at most two versions ahead of, {% data variables.product.product_location %}. For more information, see "[Upgrading GitHub Enterprise Server Backup Utilities](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance#upgrading-github-enterprise-server-backup-utilities)."

{% endnote %}

1. If {% data variables.product.product_location %} uses ephemeral self-hosted runners for {% data variables.product.prodname_actions %} and you've disabled automatic updates, upgrade your runners to the version of the runner application that your upgraded instance will run.
1. If you are upgrading using an upgrade package, schedule a maintenance window for {% data variables.product.prodname_ghe_server %} end users. If you are using a hotpatch, maintenance mode is not required.

Expand Down
1 change: 1 addition & 0 deletions data/reusables/enterprise_backup_utilities/enterprise-backup-utils-directory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1. On your backup host, navigate to your {% data variables.product.prodname_enterprise_backup_utilities %} directory, usually `backup-utils`.
11 changes: 11 additions & 0 deletions data/reusables/enterprise_backup_utilities/enterprise-backup-utils-update-repo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
1. To update to the latest project release version, use the `stable` branch by running the `git checkout stable` command.

```shell
git checkout stable
```

Alternatively, to use a specific project version, run the following command, replacing `X.Y.Z` with the desired release version.

```shell
$ git checkout vX.Y.Z
```
10 changes: 10 additions & 0 deletions ...reusables/enterprise_backup_utilities/enterprise-backup-utils-verify-upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
1. To verify you have successfully upgraded, run the following command.
```shell
./bin/ghe-backup --version
```

1. To verify SSH connectivity between your configured {% data variables.product.prodname_ghe_server %}, run the following command.
```shell
./bin/ghe-host-check
```

12 changes: 6 additions & 6 deletions lib/rest/static/decorated/api.github.com.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409371,7 +409371,7 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions",
"title": "Get all package versions for a package owned by an organization",
"title": "List package versions for a package owned by an organization",
"category": "packages",
"parameters": [
{
Expand Down Expand Up @@ -409623,7 +409623,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns all package versions for a package owned by an organization.</p>\n<p>To use this endpoint, you must authenticate using an access token with the <code>packages:read</code> scope.\nIf <code>package_type</code> is not <code>container</code>, your token must also include the <code>repo</code> scope.</p>",
"descriptionHTML": "<p>Lists package versions for a package owned by an organization.</p>\n<p>To use this endpoint, you must authenticate using an access token with the <code>packages:read</code> scope.\nIf <code>package_type</code> is not <code>container</code>, your token must also include the <code>repo</code> scope.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -415456,7 +415456,7 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/user/packages/{package_type}/{package_name}/versions",
"title": "Get all package versions for a package owned by the authenticated user",
"title": "List package versions for a package owned by the authenticated user",
"category": "packages",
"parameters": [
{
Expand Down Expand Up @@ -415706,7 +415706,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns all package versions for a package owned by the authenticated user.</p>\n<p>To use this endpoint, you must authenticate using an access token with the <code>packages:read</code> scope.\nIf <code>package_type</code> is not <code>container</code>, your token must also include the <code>repo</code> scope.</p>",
"descriptionHTML": "<p>Lists package versions for a package owned by the authenticated user.</p>\n<p>To use this endpoint, you must authenticate using an access token with the <code>packages:read</code> scope.\nIf <code>package_type</code> is not <code>container</code>, your token must also include the <code>repo</code> scope.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -421559,7 +421559,7 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions",
"title": "Get all package versions for a package owned by a user",
"title": "List package versions for a package owned by a user",
"category": "packages",
"parameters": [
{
Expand Down Expand Up @@ -421796,7 +421796,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns all package versions for a public package owned by a specified user.</p>\n<p>To use this endpoint, you must authenticate using an access token with the <code>packages:read</code> scope.\nIf <code>package_type</code> is not <code>container</code>, your token must also include the <code>repo</code> scope.</p>",
"descriptionHTML": "<p>Lists package versions for a public package owned by a specified user.</p>\n<p>To use this endpoint, you must authenticate using an access token with the <code>packages:read</code> scope.\nIf <code>package_type</code> is not <code>container</code>, your token must also include the <code>repo</code> scope.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down
20 changes: 10 additions & 10 deletions lib/rest/static/dereferenced/api.github.com.deref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119449,15 +119449,15 @@
},
"/orgs/{org}/packages/{package_type}/{package_name}/versions": {
"get": {
"summary": "Get all package versions for a package owned by an organization",
"description": "Returns all package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"summary": "List package versions for a package owned by an organization",
"description": "Lists package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"tags": [
"packages"
],
"operationId": "packages/get-all-package-versions-for-package-owned-by-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
"url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
},
"parameters": [
{
Expand Down Expand Up @@ -557521,15 +557521,15 @@
},
"/user/packages/{package_type}/{package_name}/versions": {
"get": {
"summary": "Get all package versions for a package owned by the authenticated user",
"description": "Returns all package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"summary": "List package versions for a package owned by the authenticated user",
"description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"tags": [
"packages"
],
"operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
"url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
},
"parameters": [
{
Expand Down Expand Up @@ -566243,7 +566243,7 @@
"key": {
"description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"",
"type": "string",
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
}
},
"required": [
Expand Down Expand Up @@ -595265,15 +595265,15 @@
},
"/users/{username}/packages/{package_type}/{package_name}/versions": {
"get": {
"summary": "Get all package versions for a package owned by a user",
"description": "Returns all package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"summary": "List package versions for a package owned by a user",
"description": "Lists package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"tags": [
"packages"
],
"operationId": "packages/get-all-package-versions-for-package-owned-by-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user"
"url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user"
},
"parameters": [
{
Expand Down