Deprecate 2.22 b (#22366)
* Update enterprise-server-releases.js * Run deprecation script * Remove finding / managing security vulnerabilities * remove vuln from translations * remove more dead pages * Restore heavily used files * Remove 2.22 refs in tests * Update working-with-the-npm-registry.md
This commit is contained in:
Kevin Heis
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Your account and profile on GitHub
|
||||
shortTitle: Account and profile
|
||||
intro: "Make {% data variables.product.product_name %} work best for you by adjusting the settings for your user account, personalizing your profile page, and managing the notifications you receive for activity on {% data variables.product.prodname_dotcom %}."
|
||||
intro: 'Make {% data variables.product.product_name %} work best for you by adjusting the settings for your user account, personalizing your profile page, and managing the notifications you receive for activity on {% data variables.product.prodname_dotcom %}.'
|
||||
introLinks:
|
||||
quickstart: /get-started/onboarding/getting-started-with-your-github-account
|
||||
featuredLinks:
|
||||
@@ -22,7 +22,7 @@ featuredLinks:
|
||||
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address
|
||||
- '{% ifversion ghes or ghae %}/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories{% endif %}'
|
||||
changelog:
|
||||
label: profiles, github-themes, notifications
|
||||
label: 'profiles, github-themes, notifications'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -41,3 +41,4 @@ children:
|
||||
- /setting-up-and-managing-your-github-profile
|
||||
- /managing-subscriptions-and-notifications-on-github
|
||||
---
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ To unsubscribe from conversations you're automatically subscribed to, you can ch
|
||||
|
||||
## Customizing notifications and subscriptions
|
||||
|
||||
You can choose to view your notifications through the notifications inbox at [https://github.com/notifications](https://github.com/notifications){% ifversion fpt or ghes > 2.22 or ghec %} and in the {% data variables.product.prodname_mobile %} app{% endif %}, through your email, or some combination of these options.
|
||||
You can choose to view your notifications through the notifications inbox at [https://github.com/notifications](https://github.com/notifications){% ifversion fpt or ghes or ghec %} and in the {% data variables.product.prodname_mobile %} app{% endif %}, through your email, or some combination of these options.
|
||||
|
||||
To customize the types of updates you'd like to receive and where to send those updates, configure your notification settings. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)."
|
||||
|
||||
@@ -62,7 +62,7 @@ To keep your subscriptions manageable, review your subscriptions and watched rep
|
||||
|
||||
To customize how you'd like to receive updates for specific pull requests or issues, you can configure your preferences within the issue or pull request. For more information, see "[Triaging a single notification](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification#customizing-when-to-receive-future-updates-for-an-issue-or-pull-request)."
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
You can customize and schedule push notifications in the {% data variables.product.prodname_mobile %} app. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#managing-your-notification-settings-with-github-for-mobile)."
|
||||
{% endif %}
|
||||
|
||||
@@ -92,7 +92,7 @@ From your inbox you can also triage multiple notifications at once. For more inf
|
||||
|
||||
## Customizing your notifications inbox
|
||||
|
||||
To focus on a group of notifications in your inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} or {% data variables.product.prodname_mobile %}{% endif %}, you can create custom filters. For example, you can create a custom filter for an open source project you contribute to and only see notifications for that repository in which you are mentioned. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox)." For more examples of how to customize your triaging workflow, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)."
|
||||
To focus on a group of notifications in your inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} or {% data variables.product.prodname_mobile %}{% endif %}, you can create custom filters. For example, you can create a custom filter for an open source project you contribute to and only see notifications for that repository in which you are mentioned. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox)." For more examples of how to customize your triaging workflow, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)."
|
||||
|
||||
## Notification retention policy
|
||||
|
||||
|
||||
@@ -31,11 +31,11 @@ topics:
|
||||
|
||||
You can receive notifications for activity on {% data variables.product.product_location %} in the following locations.
|
||||
|
||||
- The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
- The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes or ghec %}
|
||||
- The notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_location %}{% endif %}
|
||||
- An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}
|
||||
- An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Choosing your notification settings](#choosing-your-notification-settings)."
|
||||
{% endif %}
|
||||
|
||||
@@ -43,7 +43,7 @@ You can receive notifications for activity on {% data variables.product.product_
|
||||
|
||||
### Benefits of the notifications inbox
|
||||
|
||||
The notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} includes triaging options designed specifically for your {% data variables.product.prodname_dotcom %} notifications flow, including options to:
|
||||
The notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} includes triaging options designed specifically for your {% data variables.product.prodname_dotcom %} notifications flow, including options to:
|
||||
- Triage multiple notifications at once.
|
||||
- Mark completed notifications as **Done** and remove them from your inbox. To view all of your notifications marked as **Done**, use the `is:done` query.
|
||||
- Save a notification to review later. Saved notifications are flagged in your inbox and kept indefinitely. To view all of your saved notifications, use the `is:saved` query.
|
||||
@@ -53,7 +53,7 @@ The notifications inbox on {% data variables.product.product_location %}{% ifver
|
||||
- Create custom filters to focus on different notifications when you want.
|
||||
- Group notifications in your inbox by repository or date to get a quick overview with less context switching
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
In addition, you can receive and triage notifications on your mobile device with {% data variables.product.prodname_mobile %}. For more information, see "[Managing your notification settings with GitHub for mobile](#managing-your-notification-settings-with-github-for-mobile)" or "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)."
|
||||
{% endif %}
|
||||
|
||||
@@ -85,7 +85,7 @@ You can customize notifications for a repository. For example, you can choose to
|
||||
### Participating in conversations
|
||||
Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox.
|
||||
|
||||
For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}.
|
||||
For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}.
|
||||
|
||||
|
||||
|
||||
@@ -93,7 +93,7 @@ For example:
|
||||
- If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications.
|
||||
- If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating".
|
||||
|
||||
If you do not enable watching or participating notifications for web{% ifversion fpt or ghes > 2.22 or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates.
|
||||
If you do not enable watching or participating notifications for web{% ifversion fpt or ghes or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates.
|
||||
|
||||
## Customizing your email notifications
|
||||
|
||||
@@ -218,7 +218,7 @@ Choose how you want to receive workflow run updates for repositories that you ar
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
## Managing your notification settings with {% data variables.product.prodname_mobile %}
|
||||
|
||||
When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing notifications from your inbox
|
||||
intro: 'Use your inbox to quickly triage and sync your notifications across email{% ifversion fpt or ghes > 2.22 or ghec %} and mobile{% endif %}.'
|
||||
intro: 'Use your inbox to quickly triage and sync your notifications across email{% ifversion fpt or ghes or ghec %} and mobile{% endif %}.'
|
||||
redirect_from:
|
||||
- /articles/marking-notifications-as-read
|
||||
- /articles/saving-notifications-for-later
|
||||
@@ -21,7 +21,7 @@ shortTitle: Manage from your inbox
|
||||
|
||||
## About your inbox
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)."
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Managing the default branch name for your repositories
|
||||
intro: 'You can set the default branch name for new repositories that you create on {% data variables.product.product_location %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing your tab size rendering preference
|
||||
intro: 'You can manage the number of spaces a tab is equal to for your user account.'
|
||||
intro: You can manage the number of spaces a tab is equal to for your user account.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
|
||||
@@ -41,10 +41,10 @@ The repository owner has full control of the repository. In addition to the acti
|
||||
| Manage the repository's topics | "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" |{% ifversion fpt or ghec %}
|
||||
| Manage security and analysis settings for the repository | "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% ifversion fpt or ghec %}
|
||||
| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghec %}
|
||||
| Delete and restore packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %}{% ifversion ghes = 2.22 or ghes = 3.0 or ghae %}
|
||||
| Delete and restore packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %}{% ifversion ghes = 3.0 or ghae %}
|
||||
| Delete packages | "[Deleting packages](/packages/learn-github-packages/deleting-a-package)" |{% endif %}
|
||||
| Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" |
|
||||
| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes > 2.22 or ghae-issue-4864 or ghec %}
|
||||
| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
| Control access to {% data variables.product.prodname_dependabot_alerts %} alerts for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %}
|
||||
| Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" |
|
||||
| Manage data use for a private repository | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"|{% endif %}
|
||||
|
||||
@@ -114,7 +114,6 @@ jobs:
|
||||
path: output/test/code-coverage.html
|
||||
```
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
## Configuring a custom artifact retention period
|
||||
|
||||
You can define a custom retention period for individual artifacts created by a workflow. When using a workflow to create a new artifact, you can use `retention-days` with the `upload-artifact` action. This example demonstrates how to set a custom retention period of 5 days for the artifact named `my-artifact`:
|
||||
@@ -129,7 +128,6 @@ You can define a custom retention period for individual artifacts created by a w
|
||||
```
|
||||
|
||||
The `retention-days` value cannot exceed the retention limit set by the repository, organization, or enterprise.
|
||||
{% endif %}
|
||||
|
||||
## Downloading or deleting artifacts
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ redirect_from:
|
||||
- /actions/guides/using-github-cli-in-workflows
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=2.22'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
|
||||
@@ -6,7 +6,7 @@ redirect_from:
|
||||
- /actions/guides/building-and-testing-nodejs-or-python
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=2.22'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
|
||||
@@ -129,7 +129,6 @@ try {
|
||||
|
||||
If an error is thrown in the above `index.js` example, `core.setFailed(error.message);` uses the actions toolkit [`@actions/core`](https://github.com/actions/toolkit/tree/main/packages/core) package to log a message and set a failing exit code. For more information, see "[Setting exit codes for actions](/actions/creating-actions/setting-exit-codes-for-actions)."
|
||||
|
||||
|
||||
## Creating a README
|
||||
|
||||
To let people know how to use your action, you can create a README file. A README is most helpful when you plan to share your action publicly, but is also a great way to remind you or your team how to use the action.
|
||||
@@ -175,7 +174,6 @@ From your terminal, commit your `action.yml`, `index.js`, `node_modules`, `packa
|
||||
|
||||
It's best practice to also add a version tag for releases of your action. For more information on versioning your action, see "[About actions](/actions/automating-your-workflow-with-github-actions/about-actions#using-release-management-for-actions)."
|
||||
|
||||
|
||||
```shell
|
||||
git add action.yml index.js node_modules/* package.json package-lock.json README.md
|
||||
git commit -m "My first action is ready"
|
||||
@@ -275,7 +273,7 @@ From your repository, click the **Actions** tab, and select the latest workflow
|
||||
|
||||
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
|
||||
|
||||
{% elsif ghes > 2.22 %}
|
||||
{% elsif ghes %}
|
||||
|
||||
{% else %}
|
||||
|
||||
|
||||
@@ -269,7 +269,7 @@ For more information, see "[`github context`](/actions/reference/context-and-exp
|
||||
|
||||
#### `runs.steps[*].env`
|
||||
|
||||
**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% ifversion fpt or ghes > 2.22 or ghae or ghec %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite step.
|
||||
**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use `echo "{name}={value}" >> $GITHUB_ENV` in a composite step.
|
||||
|
||||
#### `runs.steps[*].working-directory`
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ redirect_from:
|
||||
You can deliver deployments through {% ifversion fpt or ghae or ghes > 3.0 or ghec %}{% data variables.product.prodname_actions %} and environments or with {% endif %}the REST API and third party apps. {% ifversion fpt or ghae ghes > 3.0 or ghec %}For more information about using environments to deploy with {% data variables.product.prodname_actions %}, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." {% endif %}For more information about deployments with the REST API, see "[Repositories](/rest/reference/repos#deployments)."
|
||||
|
||||
To view current and past deployments, click **Environments** on the home page of your repository.
|
||||
{% ifversion ghae or ghes < 3.0 %}
|
||||
{% ifversion ghae %}
|
||||
{% else %}
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
title: Autoscaling with self-hosted runners
|
||||
intro: 'You can automatically scale your self-hosted runners in response to webhook events.'
|
||||
intro: You can automatically scale your self-hosted runners in response to webhook events.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.2'
|
||||
type: 'overview'
|
||||
type: overview
|
||||
---
|
||||
|
||||
{% data reusables.actions.ae-self-hosted-runners-notice %}
|
||||
|
||||
@@ -66,7 +66,7 @@ When creating a group, you must choose a policy that defines which repositories
|
||||
|
||||
1. Enter a name for your runner group, and assign a policy for repository access.
|
||||
|
||||
{% ifversion ghes > 2.22 or ghae %} You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.{% endif %}{% ifversion ghes = 2.22 %}You can configure a runner group to be accessible to a specific list of repositories, all private repositories, or all repositories in the organization.{% endif %}
|
||||
{% ifversion ghes or ghae %} You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.{% endif %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
@@ -82,7 +82,6 @@ When creating a group, you must choose a policy that defines which repositories
|
||||
1. Click **Save group** to create the group and apply the policy.
|
||||
{% endif %}
|
||||
|
||||
|
||||
## Creating a self-hosted runner group for an enterprise
|
||||
|
||||
Enterprises can add their self-hosted runners to groups for access management. Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account. Organization admins can then assign additional granular repository access policies to the enterprise runner groups. For information about how to create a self-hosted runner group with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions).
|
||||
@@ -120,7 +119,7 @@ When creating a group, you must choose a policy that defines which organizations
|
||||
|
||||
1. Enter a name for your runner group, and assign a policy for organization access.
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %} You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.{% elsif ghes = 2.22 %}You can configure a runner group to be accessible to all organizations in the enterprise or choose specific organizations.{% endif %}
|
||||
You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.
|
||||
|
||||
{% warning %}
|
||||
|
||||
|
||||
@@ -62,3 +62,4 @@ children:
|
||||
- /migrating-to-github-actions
|
||||
- /guides
|
||||
---
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ To use the value of an environment variable in a workflow file, you should use t
|
||||
|
||||
If you use the workflow file's `run` key to read environment variables from within the runner operating system (as shown in the example above), the variable is substituted in the runner operating system after the job is sent to the runner. For other parts of a workflow file, you must use the `env` context to read environment variables; this is because workflow keys (such as `if`) require the variable to be substituted during workflow processing before it is sent to the runner.
|
||||
|
||||
You can also use the {% ifversion fpt or ghes > 2.22 or ghae or ghec %}`GITHUB_ENV` environment file{% else %} `set-env` workflow command{% endif %} to set an environment variable that the following steps in a job can use. The {% ifversion fpt or ghes > 2.22 or ghae or ghec %}environment file{% else %} `set-env` command{% endif %} can be used directly by an action or as a shell command in a workflow file using the `run` keyword. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-environment-variable)."
|
||||
You can also use the `GITHUB_ENV` environment file to set an environment variable that the following steps in a job can use. The environment file can be used directly by an action or as a shell command in a workflow file using the `run` keyword. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-environment-variable)."
|
||||
|
||||
## Default environment variables
|
||||
|
||||
|
||||
@@ -674,8 +674,6 @@ on:
|
||||
|
||||
{% data reusables.developer-site.pull_request_forked_repos_link %}
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
|
||||
### `pull_request_target`
|
||||
|
||||
This event runs in the context of the base of the pull request, rather than in the merge commit as the `pull_request` event does. This prevents executing unsafe workflow code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows you to do things like create workflows that label and comment on pull requests based on the contents of the event payload.
|
||||
@@ -700,8 +698,6 @@ on:
|
||||
types: [assigned, opened, synchronize, reopened]
|
||||
```
|
||||
|
||||
{% endif %}
|
||||
|
||||
### `push`
|
||||
|
||||
{% note %}
|
||||
@@ -808,8 +804,6 @@ on:
|
||||
types: [started]
|
||||
```
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
|
||||
### `workflow_run`
|
||||
|
||||
{% data reusables.webhooks.workflow_run_desc %}
|
||||
@@ -836,8 +830,6 @@ on:
|
||||
- requested
|
||||
```
|
||||
|
||||
{% endif %}
|
||||
|
||||
To run a workflow job conditionally based on the result of the previous workflow run, you can use the [`jobs.<job_id>.if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) or [`jobs.<job_id>.steps[*].if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif) conditional combined with the `conclusion` of the previous run. For example:
|
||||
|
||||
```yaml
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
---
|
||||
title: Reusing workflows
|
||||
shortTitle: Reusing workflows
|
||||
intro: 'Learn how to avoid duplication when creating a workflow by reusing existing workflows.'
|
||||
intro: Learn how to avoid duplication when creating a workflow by reusing existing workflows.
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=3.4'
|
||||
ghae: 'issue-4757'
|
||||
ghae: issue-4757
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Sharing workflows, secrets, and runners with your organization
|
||||
title: 'Sharing workflows, secrets, and runners with your organization'
|
||||
shortTitle: Sharing workflows with your organization
|
||||
intro: 'Learn how you can use organization features to collaborate with your team, by sharing workflow templates, secrets, and self-hosted runners.'
|
||||
redirect_from:
|
||||
|
||||
@@ -213,7 +213,6 @@ In this diagram, you can see the workflow file you just created and how the {% d
|
||||
|
||||
|
||||
|
||||
|
||||
## Viewing the job's activity
|
||||
|
||||
Once your job has started running, you can {% ifversion fpt or ghes > 3.0 or ghae or ghec %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}.
|
||||
@@ -232,7 +231,7 @@ Once your job has started running, you can {% ifversion fpt or ghes > 3.0 or gha
|
||||
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
|
||||
1. View the results of each step.
|
||||
|
||||
{% elsif ghes > 2.22 %}
|
||||
{% elsif ghes %}
|
||||
1. Click on the job name to see the results of each step.
|
||||
|
||||
{% else %}
|
||||
|
||||
@@ -71,7 +71,6 @@ In addition to the usage limits, you must ensure that you use {% data variables.
|
||||
If you reuse a workflow, billing is always associated with the caller workflow. For more information see, "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
## Artifact and log retention policy
|
||||
|
||||
You can configure the artifact and log retention period for your repository, organization, or enterprise account.
|
||||
@@ -83,7 +82,6 @@ For more information, see:
|
||||
- "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)"
|
||||
- "[Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)"
|
||||
- "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)"
|
||||
{% endif %}
|
||||
|
||||
## Disabling or limiting {% data variables.product.prodname_actions %} for your repository or organization
|
||||
|
||||
@@ -94,7 +92,6 @@ For more information, see:
|
||||
- "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)"
|
||||
- "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-github-actions-policies-for-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)"
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
## Disabling and enabling workflows
|
||||
|
||||
You can enable and disable individual workflows in your repository on {% data variables.product.prodname_dotcom %}.
|
||||
@@ -102,4 +99,3 @@ You can enable and disable individual workflows in your repository on {% data va
|
||||
{% data reusables.actions.scheduled-workflows-disabled %}
|
||||
|
||||
For more information, see "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)."
|
||||
{% endif %}
|
||||
|
||||
@@ -24,11 +24,7 @@ versions:
|
||||
|
||||
Actions can communicate with the runner machine to set environment variables, output values used by other actions, add debug messages to the output logs, and other tasks.
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
Most workflow commands use the `echo` command in a specific format, while others are invoked by writing to a file. For more information, see ["Environment files".](#environment-files)
|
||||
{% else %}
|
||||
Workflow commands use the `echo` command in a specific format.
|
||||
{% endif %}
|
||||
|
||||
``` bash
|
||||
echo "::workflow-command parameter1={data},parameter2={data}::{command value}"
|
||||
@@ -70,12 +66,12 @@ The following table shows which toolkit functions are available within a workflo
|
||||
|
||||
| Toolkit function | Equivalent workflow command |
|
||||
| ----------------- | ------------- |
|
||||
| `core.addPath` | {% ifversion fpt or ghes > 2.22 or ghae or ghec %}Accessible using environment file `GITHUB_PATH`{% else %} `add-path` {% endif %} |
|
||||
| `core.addPath` | Accessible using environment file `GITHUB_PATH` |
|
||||
| `core.debug` | `debug` |{% ifversion fpt or ghes > 3.2 or ghae-issue-4929 or ghec %}
|
||||
| `core.notice` | `notice` |{% endif %}
|
||||
| `core.error` | `error` |
|
||||
| `core.endGroup` | `endgroup` |
|
||||
| `core.exportVariable` | {% ifversion fpt or ghes > 2.22 or ghae or ghec %}Accessible using environment file `GITHUB_ENV`{% else %} `set-env` {% endif %} |
|
||||
| `core.exportVariable` | Accessible using environment file `GITHUB_ENV` |
|
||||
| `core.getInput` | Accessible using environment variable `INPUT_{NAME}` |
|
||||
| `core.getState` | Accessible using environment variable `STATE_{NAME}` |
|
||||
| `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` |
|
||||
@@ -86,22 +82,6 @@ The following table shows which toolkit functions are available within a workflo
|
||||
| `core.startGroup` | `group` |
|
||||
| `core.warning` | `warning` |
|
||||
|
||||
{% ifversion ghes < 3.0 %}
|
||||
## Setting an environment variable
|
||||
|
||||
```
|
||||
::set-env name={name}::{value}
|
||||
```
|
||||
|
||||
Creates or updates an environment variable for any steps running next in a job. The step that creates or updates the environment variable does not have access to the new value, but all subsequent steps in a job will have access. Environment variables are case-sensitive and you can include punctuation.
|
||||
|
||||
### Example
|
||||
|
||||
``` bash
|
||||
echo "::set-env name=action_state::yellow"
|
||||
```
|
||||
{% endif %}
|
||||
|
||||
## Setting an output parameter
|
||||
|
||||
```
|
||||
@@ -118,22 +98,6 @@ Optionally, you can also declare output parameters in an action's metadata file.
|
||||
echo "::set-output name=action_fruit::strawberry"
|
||||
```
|
||||
|
||||
{% ifversion ghes < 3.0 %}
|
||||
## Adding a system path
|
||||
|
||||
```
|
||||
::add-path::{path}
|
||||
```
|
||||
|
||||
Prepends a directory to the system `PATH` variable for all subsequent actions in the current job. The currently running action cannot access the new path variable.
|
||||
|
||||
### Example
|
||||
|
||||
``` bash
|
||||
echo "::add-path::/path/to/dir"
|
||||
```
|
||||
{% endif %}
|
||||
|
||||
## Setting a debug message
|
||||
|
||||
```
|
||||
@@ -302,7 +266,6 @@ The `STATE_processID` variable is then exclusively available to the cleanup scri
|
||||
console.log("The running PID from the main action is: " + process.env.STATE_processID);
|
||||
```
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
## Environment Files
|
||||
|
||||
During the execution of a workflow, the runner generates temporary files that can be used to perform certain actions. The path to these files are exposed via environment variables. You will need to use UTF-8 encoding when writing to these files to ensure proper processing of the commands. Multiple commands can be written to the same file, separated by newlines.
|
||||
@@ -386,4 +349,3 @@ This example demonstrates how to add the user `$HOME/.local/bin` directory to `P
|
||||
``` bash
|
||||
echo "$HOME/.local/bin" >> $GITHUB_PATH
|
||||
```
|
||||
{% endif %}
|
||||
|
||||
@@ -541,7 +541,6 @@ environment:
|
||||
{% endraw %}
|
||||
{% endif %}
|
||||
|
||||
|
||||
{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}
|
||||
## `jobs.<job_id>.concurrency`
|
||||
|
||||
@@ -955,7 +954,6 @@ steps:
|
||||
|
||||
The command used, `perl` in this example, must be installed on the runner.
|
||||
|
||||
|
||||
{% ifversion ghae %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)."
|
||||
{% else %}
|
||||
For information about the software included on GitHub-hosted runners, see "[Specifications for GitHub-hosted runners](/actions/reference/specifications-for-github-hosted-runners#supported-software)."
|
||||
@@ -1274,9 +1272,7 @@ jobs:
|
||||
|
||||
## `jobs.<job_id>.container.image`
|
||||
|
||||
The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a {% ifversion ghes < 3.0 %}public{% endif %} registry name.
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name.
|
||||
|
||||
## `jobs.<job_id>.container.credentials`
|
||||
|
||||
@@ -1293,7 +1289,6 @@ container:
|
||||
password: ${{ secrets.ghcr_token }}
|
||||
```
|
||||
{% endraw %}
|
||||
{% endif %}
|
||||
|
||||
## `jobs.<job_id>.container.env`
|
||||
|
||||
@@ -1364,9 +1359,7 @@ services:
|
||||
|
||||
## `jobs.<job_id>.services.<service_id>.image`
|
||||
|
||||
The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a {% ifversion ghes < 3.0 %}public{% endif %} registry name.
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a registry name.
|
||||
|
||||
## `jobs.<job_id>.services.<service_id>.credentials`
|
||||
|
||||
@@ -1389,7 +1382,6 @@ services:
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
```
|
||||
{% endraw %}
|
||||
{% endif %}
|
||||
|
||||
## `jobs.<job_id>.services.<service_id>.env`
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Disabling and enabling a workflow
|
||||
intro: 'You can disable and re-enable a workflow using the {% data variables.product.prodname_dotcom %} UI, the REST API, or {% data variables.product.prodname_cli %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Disable & enable a workflow
|
||||
|
||||
@@ -13,8 +13,7 @@ shortTitle: Download workflow artifacts
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %}
|
||||
{% ifversion ghes = 2.22 %} {% data variables.product.product_name %} stores full build logs and artifacts for 90 days.{% endif %}
|
||||
By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."
|
||||
|
||||
{% data reusables.repositories.permissions-statement-read %}
|
||||
|
||||
|
||||
@@ -36,7 +36,6 @@ shortTitle: Remove workflow artifacts
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
## Setting the retention period for an artifact
|
||||
|
||||
Retention periods for artifacts and logs can be configured at the repository, organization, and enterprise level. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)."
|
||||
@@ -46,4 +45,3 @@ You can also define a custom retention period for individual artifacts using the
|
||||
## Finding the expiration date of an artifact
|
||||
|
||||
You can use the API to confirm the date that an artifact is scheduled to be deleted. For more information, see the `expires_at` value returned by "[List artifacts for a repository](/rest/reference/actions#artifacts)."
|
||||
{% endif %}
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
title: Skipping workflow runs
|
||||
intro: 'You can skip workflow runs triggered by the `push` and `pull_request` events by including a command in your commit message.'
|
||||
intro: You can skip workflow runs triggered by the `push` and `pull_request` events by including a command in your commit message.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=3.0'
|
||||
ghae: 'ghae-next'
|
||||
ghes: '*'
|
||||
ghae: ghae-next
|
||||
ghec: '*'
|
||||
shortTitle: Skip workflow runs
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Notifications for workflow runs
|
||||
intro: 'You can subscribe to notifications about workflow runs that you trigger.'
|
||||
intro: You can subscribe to notifications about workflow runs that you trigger.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
|
||||
@@ -47,19 +47,12 @@ You can search the build logs for a particular step. When you search logs, only
|
||||
{% data reusables.repositories.navigate-to-workflow-superlinter %}
|
||||
{% data reusables.repositories.view-run-superlinter %}
|
||||
{% data reusables.repositories.navigate-to-job-superlinter %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
1. In the upper-right corner of the log output, in the **Search logs** search box, type a search query.
|
||||
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
|
||||
|
||||
{% else %}
|
||||
|
||||
{% endif %}
|
||||
{% else %}
|
||||
1. To expand each step you want to include in your search, click the step.
|
||||
|
||||
1. In the upper-right corner of the log output, in the **Search logs** search box, type a search query.
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Downloading logs
|
||||
|
||||
@@ -70,17 +63,12 @@ You can download the log files from your workflow run. You can also download a w
|
||||
{% data reusables.repositories.navigate-to-workflow-superlinter %}
|
||||
{% data reusables.repositories.view-run-superlinter %}
|
||||
{% data reusables.repositories.navigate-to-job-superlinter %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
1. In the upper right corner, click {% ifversion fpt or ghes > 3.0 or ghae or ghec %}{% octicon "gear" aria-label="The gear icon" %}{% else %}{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}{% endif %} and select **Download log archive**.
|
||||
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
|
||||
|
||||
{% else %}
|
||||
|
||||
{% endif %}
|
||||
{% else %}
|
||||
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Download log archive**.
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Deleting logs
|
||||
|
||||
@@ -90,7 +78,6 @@ You can delete the log files from your workflow run. {% data reusables.repositor
|
||||
{% data reusables.repositories.actions-tab %}
|
||||
{% data reusables.repositories.navigate-to-workflow-superlinter %}
|
||||
{% data reusables.repositories.view-run-superlinter %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
|
||||
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
|
||||
|
||||
@@ -104,13 +91,6 @@ You can delete the log files from your workflow run. {% data reusables.repositor
|
||||
|
||||
{% endif %}
|
||||
After deleting logs, the **Delete all logs** button is removed to indicate that no log files remain in the workflow run.
|
||||
{% else %}
|
||||
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
|
||||
|
||||
2. To delete the log files, click the **Delete all logs** button and review the confirmation prompt.
|
||||
|
||||
After the logs have been deleted, the **Delete all logs** button is removed to indicate that no log files remain in the workflow run.
|
||||
{% endif %}
|
||||
|
||||
## Viewing logs with {% data variables.product.prodname_cli %}
|
||||
|
||||
|
||||
@@ -327,17 +327,13 @@ The following tables describe the {% data variables.product.prodname_actions %}
|
||||
| `enterprise.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an enterprise](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-enterprise)."
|
||||
| `enterprise.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)."
|
||||
| `enterprise.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group.
|
||||
| `enterprise.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)."{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
| `enterprise.runner_group_updated` |Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."{% endif %}{% ifversion ghes = 2.22 %}
|
||||
| `enterprise.runner_group_renamed` | Triggered when the self-hosted runner group is renamed.
|
||||
| `enterprise.runner_group_visiblity_updated` | Triggered when the visibility settings of the self-hosted runner group are changed.{% endif %}
|
||||
| `enterprise.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)."
|
||||
| `enterprise.runner_group_updated` |Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."
|
||||
| `org.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an organization](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)."
|
||||
| `org.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)."{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
| `org.runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."{% endif %}
|
||||
| `org.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)."
|
||||
| `org.runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."
|
||||
| `org.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)."
|
||||
| `org.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)."{% ifversion ghes = 2.22 %}
|
||||
| `org.runner_group_renamed` | Triggered when the self-hosted runner group is renamed.
|
||||
| `org.runner_group_visiblity_updated` | Triggered when the visibility settings of the self-hosted runner group are changed.{% endif %}
|
||||
| `org.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)."
|
||||
|
||||
### Events for workflow activities
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ You must ensure that Git is in the PATH variable on any self-hosted runners you
|
||||
|
||||
### Provisioning the actions for {% data variables.product.prodname_code_scanning %}
|
||||
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
If you want to use actions to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.prodname_ghe_server %}, the actions must be available on your appliance.
|
||||
|
||||
The {% data variables.product.prodname_codeql %} action is included in your installation of {% data variables.product.prodname_ghe_server %}. If {% data variables.product.prodname_ghe_server %} has access to the internet, the action will automatically download the {% data variables.product.prodname_codeql %} bundle required to perform analysis. Alternatively, you can use a synchronization tool to make the {% data variables.product.prodname_codeql %} analysis bundle available locally. For more information, see "[Configuring {% data variables.product.prodname_codeql %} analysis on a server without internet access](#configuring-codeql-analysis-on-a-server-without-internet-access)" below.
|
||||
@@ -59,13 +59,6 @@ If you set up the {% data variables.product.prodname_codeql %} action sync tool,
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes = 2.22 %}
|
||||
To run {% data variables.product.prodname_code_scanning %} on {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %}, the appropriate actions must be available locally. You can make the actions available in three ways.
|
||||
|
||||
- **Recommended**: You can use [{% data variables.product.prodname_github_connect %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud) to automatically download actions from {% data variables.product.prodname_dotcom_the_website %}. The machine that hosts your instance must be able to access {% data variables.product.prodname_dotcom_the_website %}. This approach ensures that you get the latest software automatically. For more information, see "[Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)."
|
||||
- If you want to use the {% data variables.product.prodname_codeql_workflow %}, you can sync the repository from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}, by using the {% data variables.product.prodname_codeql %} Action sync tool available at [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). You can use this tool regardless of whether {% data variables.product.product_location %} or your {% data variables.product.prodname_actions %} runners have access to the internet, as long as you can access both {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %} simultaneously on your computer.
|
||||
- You can create a local copy of an action's repository on your server, by cloning the {% data variables.product.prodname_dotcom_the_website %} repository that contains the action. For example, if you want to use the actions for {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}, you can create a repository in your instance called `github/codeql-action`, then clone the [repository](https://github.com/github/codeql-action) from {% data variables.product.prodname_dotcom_the_website %}, and then push that repository to your instance's `github/codeql-action` repository. You will also need to download any of the releases from the repository on {% data variables.product.prodname_dotcom_the_website %} and upload them to your instance's `github/codeql-action` repository as releases.
|
||||
{% endif %}
|
||||
|
||||
### Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}
|
||||
1. If you want to download action workflows on demand from {% data variables.product.prodname_dotcom_the_website %}, you need to enable {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling {% data variables.product.prodname_github_connect %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud#enabling-github-connect)."
|
||||
|
||||
@@ -7,7 +7,7 @@ miniTocMaxHeadingLevel: 3
|
||||
redirect_from:
|
||||
- /admin/configuration/configuring-secret-scanning-for-your-appliance
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Advanced Security
|
||||
|
||||
@@ -4,7 +4,7 @@ intro: 'Learn how to plan, prepare, and implement a phased approach for rolling
|
||||
product: '{% data reusables.gated-features.advanced-security %}'
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
|
||||
@@ -24,7 +24,7 @@ When you enable {% data variables.product.prodname_GH_advanced_security %} for y
|
||||
When you enable {% data variables.product.prodname_GH_advanced_security %} for your enterprise, repository administrators in all organizations can enable the features. {% ifversion ghes = 3.0 %}For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying GitHub Advanced Security in your enterprise](/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise)."
|
||||
{% endif %}
|
||||
|
||||
@@ -32,7 +32,7 @@ For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying
|
||||
|
||||
1. Upgrade your license for {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes > 3.0 %} For information about licensing, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %}
|
||||
2. Download the new license file. For more information, see "[Downloading your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)."
|
||||
3. Upload the new license file to {% data variables.product.product_location %}. For more information, see "[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes > 2.22 %}
|
||||
3. Upload the new license file to {% data variables.product.product_location %}. For more information, see "[Uploading a new license to {% data variables.product.prodname_ghe_server %}](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes %}
|
||||
4. Review the prerequisites for the features you plan to enable.
|
||||
|
||||
- {% data variables.product.prodname_code_scanning_capc %}, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)."
|
||||
@@ -49,7 +49,7 @@ For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes = 2.22 or ghes = 3.0 %}
|
||||
{% ifversion ghes = 3.0 %}
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
1. If your license includes {% data variables.product.prodname_GH_advanced_security %}, there is an **{% data variables.product.prodname_advanced_security %}** entry in the left sidebar.
|
||||
@@ -64,7 +64,7 @@ For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.advanced-security-tab %}{% ifversion ghes > 2.22 %}
|
||||
{% data reusables.enterprise_management_console.advanced-security-tab %}{% ifversion ghes %}
|
||||
1. Under "{% ifversion ghes < 3.2 %}{% data variables.product.prodname_advanced_security %}{% else %}Security{% endif %}," select the features that you want to enable and deselect any features you want to disable.
|
||||
{% else %}
|
||||
1. Under "{% data variables.product.prodname_advanced_security %}," click **{% data variables.product.prodname_code_scanning_capc %}**.
|
||||
|
||||
@@ -19,3 +19,4 @@ children:
|
||||
- /overview-of-github-advanced-security-deployment
|
||||
- /deploying-github-advanced-security-in-your-enterprise
|
||||
---
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ intro: 'Help your company successfully prepare to adopt {% data variables.produc
|
||||
product: '{% data variables.product.prodname_GH_advanced_security %} is a set of security features designed to make enterprise code more secure. It is available for {% data variables.product.prodname_ghe_server %} 3.0 or higher, {% data variables.product.prodname_ghe_cloud %}, and open source repositories. To learn more about the features, included in {% data variables.product.prodname_GH_advanced_security %}, see "[About GitHub Advanced Security](/get-started/learning-about-github/about-github-advanced-security)."'
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Authentication
|
||||
intro: 'You can configure how users access your enterprise.'
|
||||
intro: You can configure how users access your enterprise.
|
||||
redirect_from:
|
||||
- /enterprise/admin/authentication
|
||||
versions:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Configuring SAML single sign-on for your enterprise
|
||||
shortTitle: Configure SAML SSO
|
||||
intro: "You can control and secure access to {% ifversion ghec %}resources like repositories, issues, and pull requests within your enterprise's organizations{% elsif ghae %}your enterprise on {% data variables.product.prodname_ghe_managed %}{% endif %} by {% ifversion ghec %}enforcing{% elsif ghae %}configuring{% endif %} SAML single sign-on (SSO) through your identity provider (IdP)."
|
||||
intro: 'You can control and secure access to {% ifversion ghec %}resources like repositories, issues, and pull requests within your enterprise''s organizations{% elsif ghae %}your enterprise on {% data variables.product.prodname_ghe_managed %}{% endif %} by {% ifversion ghec %}enforcing{% elsif ghae %}configuring{% endif %} SAML single sign-on (SSO) through your identity provider (IdP).'
|
||||
product: '{% data reusables.gated-features.saml-sso %}'
|
||||
permissions: 'Enterprise owners can configure SAML SSO for an enterprise on {% data variables.product.product_name %}.'
|
||||
versions:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Managing identity and access for your enterprise
|
||||
shortTitle: Managing identity and access
|
||||
intro: "You can centrally manage {% ifversion ghae %}accounts and {% endif %}access to your {% ifversion ghae %}enterprise{% elsif ghec %}enterprise's resources{% endif %} on {% data variables.product.product_name %} with SAML single sign-on (SSO) and System for Cross-domain Identity Management (SCIM)."
|
||||
intro: 'You can centrally manage {% ifversion ghae %}accounts and {% endif %}access to your {% ifversion ghae %}enterprise{% elsif ghec %}enterprise''s resources{% endif %} on {% data variables.product.product_name %} with SAML single sign-on (SSO) and System for Cross-domain Identity Management (SCIM).'
|
||||
versions:
|
||||
ghec: '*'
|
||||
ghae: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Switching your SAML configuration from an organization to an enterprise account
|
||||
intro: 'Learn special considerations and best practices for replacing an organization-level SAML configuration with an enterprise-level SAML configuration.'
|
||||
intro: Learn special considerations and best practices for replacing an organization-level SAML configuration with an enterprise-level SAML configuration.
|
||||
product: '{% data reusables.gated-features.enterprise-accounts %}'
|
||||
permissions: Enterprise owners can configure SAML single sign-on for an enterprise account.
|
||||
versions:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: About Enterprise Managed Users
|
||||
shortTitle: About managed users
|
||||
intro: You can centrally manage identity and access for your enterprise members on {% data variables.product.prodname_dotcom %} from your identity provider.
|
||||
intro: 'You can centrally manage identity and access for your enterprise members on {% data variables.product.prodname_dotcom %} from your identity provider.'
|
||||
product: '{% data reusables.gated-features.emus %}'
|
||||
redirect_from:
|
||||
- /early-access/github/articles/get-started-with-managed-users-for-your-enterprise
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Auditing activity in your enterprise
|
||||
shortTitle: Auditing activity
|
||||
intro: 'You can audit the activity of the {% data variables.product.prodname_managed_users %} in your enterprise, viewing information about what actions were performed, by which user, and when they took place.'
|
||||
permissions: 'Enterprise owners can access the audit log.'
|
||||
permissions: Enterprise owners can access the audit log.
|
||||
product: '{% data reusables.gated-features.emus %}'
|
||||
redirect_from:
|
||||
- /github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/auditing-activity-in-your-enterprise
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Configuring SCIM provisioning for Enterprise Managed Users with Okta
|
||||
shortTitle: Set up provisioning with Okta
|
||||
intro: 'You can provision new users and manage their membership of your enterprise and teams using Okta as your identity provider.'
|
||||
intro: You can provision new users and manage their membership of your enterprise and teams using Okta as your identity provider.
|
||||
product: '{% data reusables.gated-features.emus %}'
|
||||
versions:
|
||||
ghec: '*'
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Configuring SCIM provisioning for Enterprise Managed Users
|
||||
shortTitle: Provisioning managed users
|
||||
intro: 'You can configure your identity provider to provision new users and manage their membership in your enterprise and teams.'
|
||||
intro: You can configure your identity provider to provision new users and manage their membership in your enterprise and teams.
|
||||
product: '{% data reusables.gated-features.emus %}'
|
||||
redirect_from:
|
||||
- /github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/configuring-scim-provisioning-for-enterprise-managed-users
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Managing your enterprise users with your identity provider
|
||||
shortTitle: Manage users with your IdP
|
||||
product: '{% data reusables.gated-features.emus %}'
|
||||
intro: 'You can manage identity and access with your identity provider and provision accounts that can only contribute to your enterprise.'
|
||||
intro: You can manage identity and access with your identity provider and provision accounts that can only contribute to your enterprise.
|
||||
redirect_from:
|
||||
- /github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/
|
||||
versions:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Managing team memberships with identity provider groups
|
||||
shortTitle: Manage teams with your IdP
|
||||
intro: You can manage team membership on {% data variables.product.product_name %} through your identity provider (IdP) by connecting IdP groups with your {% data variables.product.prodname_emu_enterprise %}.
|
||||
intro: 'You can manage team membership on {% data variables.product.product_name %} through your identity provider (IdP) by connecting IdP groups with your {% data variables.product.prodname_emu_enterprise %}.'
|
||||
product: '{% data reusables.gated-features.emus %}'
|
||||
redirect_from:
|
||||
- /github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/managing-team-memberships-with-identity-provider-groups
|
||||
|
||||
@@ -23,13 +23,6 @@ Subdomain isolation mitigates cross-site scripting and other related vulnerabili
|
||||
|
||||
When subdomain isolation is enabled, {% data variables.product.prodname_ghe_server %} replaces several paths with subdomains. After enabling subdomain isolation, attempts to access the previous paths for some user-supplied content, such as `http(s)://HOSTNAME/raw/`, may return `404` errors.
|
||||
|
||||
{% ifversion ghes = 2.22 %}
|
||||
To use Docker with {% data variables.product.prodname_registry %}, you must also enable subdomain isolation. For more information, see "[Working with the Docker registry](/enterprise/{{ currentVersion }}/user/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)."
|
||||
|
||||
{% data reusables.package_registry.packages-ghes-release-stage %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
| Path without subdomain isolation | Path with subdomain isolation |
|
||||
| --- | --- |
|
||||
| `http(s)://HOSTNAME/assets/` | `http(s)://assets.HOSTNAME/` |
|
||||
@@ -41,9 +34,8 @@ To use Docker with {% data variables.product.prodname_registry %}, you must also
|
||||
| `http(s)://HOSTNAME/raw/` | `http(s)://raw.HOSTNAME/` |
|
||||
| `http(s)://HOSTNAME/render/` | `http(s)://render.HOSTNAME/` |
|
||||
| `http(s)://HOSTNAME/reply/` | `http(s)://reply.HOSTNAME/` |
|
||||
| `http(s)://HOSTNAME/uploads/` | `http(s)://uploads.HOSTNAME/` |{% ifversion ghes = 2.22 %}
|
||||
| N/A, Docker with {% data variables.product.prodname_registry %} will not work with subdomain isolation disabled for the {% data variables.product.prodname_registry %} 2.22 beta. | `http(s)://docker.HOSTNAME/` |{% endif %} {% ifversion ghes > 2.22 %}
|
||||
| `https://HOSTNAME/_registry/docker/` | `http(s)://docker.HOSTNAME/`{% endif %}{% ifversion ghes > 2.22 %}
|
||||
| `http(s)://HOSTNAME/uploads/` | `http(s)://uploads.HOSTNAME/` | {% ifversion ghes %}
|
||||
| `https://HOSTNAME/_registry/docker/` | `http(s)://docker.HOSTNAME/`{% endif %}{% ifversion ghes %}
|
||||
| `https://HOSTNAME/_registry/npm/` | `https://npm.HOSTNAME/`
|
||||
| `https://HOSTNAME/_registry/rubygems/` | `https://rubygems.HOSTNAME/`
|
||||
| `https://HOSTNAME/_registry/maven/` | `https://maven.HOSTNAME/`
|
||||
|
||||
@@ -493,7 +493,7 @@ ghe-webhook-logs
|
||||
```
|
||||
|
||||
To show all failed hook deliveries in the past day:
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
```shell
|
||||
ghe-webhook-logs -f -a <em>YYYY-MM-DD</em>
|
||||
```
|
||||
@@ -506,7 +506,7 @@ ghe-webhook-logs -f -a <em>YYYYMMDD</em>
|
||||
{% endif %}
|
||||
|
||||
To show the full hook payload, result, and any exceptions for the delivery:
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
```shell
|
||||
ghe-webhook-logs -g <em>delivery-guid</em>
|
||||
```
|
||||
|
||||
@@ -94,7 +94,7 @@ If backup attempts overlap, the `ghe-backup` command will abort with an error me
|
||||
|
||||
In the event of prolonged outage or catastrophic event at the primary site, you can restore {% data variables.product.product_location %} by provisioning another {% data variables.product.prodname_enterprise %} appliance and performing a restore from the backup host. You must add the backup host's SSH key to the target {% data variables.product.prodname_enterprise %} appliance as an authorized SSH key before restoring an appliance.
|
||||
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
{% note %}
|
||||
|
||||
**Note:** If {% data variables.product.product_location %} has {% data variables.product.prodname_actions %} enabled, you must first configure the {% data variables.product.prodname_actions %} external storage provider on the replacement appliance before running the `ghe-restore` command. For more information, see "[Backing up and restoring {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %} enabled](/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)."
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Managing GitHub for mobile for your enterprise
|
||||
intro: 'You can decide whether authenticated users can connect to {% data variables.product.product_location %} with {% data variables.product.prodname_mobile %}.'
|
||||
permissions: 'Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
|
||||
@@ -13,7 +13,7 @@ redirect_from:
|
||||
permissions: 'Enterprise owners who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
|
||||
@@ -12,7 +12,7 @@ redirect_from:
|
||||
permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot %} alerts on {% data variables.product.product_location %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: "issue-4864"
|
||||
ghae: issue-4864
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
|
||||
@@ -13,7 +13,7 @@ redirect_from:
|
||||
permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified contributions between {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
|
||||
@@ -13,7 +13,7 @@ redirect_from:
|
||||
permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified search between {% data variables.product.product_name %} and {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
|
||||
@@ -11,7 +11,7 @@ redirect_from:
|
||||
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
|
||||
@@ -79,7 +79,7 @@ Run the `ghe-upgrade` command, providing the package file name you downloaded in
|
||||
> gpg: depth: 0 valid: 1 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 1u
|
||||
> gpg: Good signature from "GitHub Enterprise (Upgrade Package Key) > <enterprise@github.com>"
|
||||
```
|
||||
5. The upgrade process will reboot the primary MySQL node once it completes. Verify that you can `ping` each node after it reboots.{% ifversion ghes > 2.22 %}
|
||||
5. The upgrade process will reboot the primary MySQL node once it completes. Verify that you can `ping` each node after it reboots.{% ifversion ghes %}
|
||||
6. Connect to the administrative shell of the primary MySQL node and run the `ghe-cluster-config-apply` command.
|
||||
7. When `ghe-cluster-config-apply` is complete, check that the services are in a healthy state by running `ghe-cluster-status`.{% endif %}
|
||||
8. Exit maintenance mode from the administrative shell of any node by running `ghe-cluster-maintenance -u`.
|
||||
|
||||
@@ -39,7 +39,7 @@ shortTitle: Remove a HA replica
|
||||
$ ghe-repl-teardown
|
||||
```
|
||||
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
{% note %}
|
||||
|
||||
**Note:** If you have {% data variables.product.prodname_actions %} enabled, you should decommission the former replica server or update its {% data variables.product.prodname_actions %} configuration to use different external storage. For more information, see "[High availability for {% data variables.product.prodname_actions %}](/admin/github-actions/high-availability-for-github-actions#high-availability-replicas)."
|
||||
|
||||
@@ -68,9 +68,9 @@ There are two types of snapshots:
|
||||
|
||||
{% note %}
|
||||
|
||||
**{% ifversion ghes > 2.22 %}Notes{% else %}Note{% endif %}**:
|
||||
**{% ifversion ghes %}Notes{% else %}Note{% endif %}**:
|
||||
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
- If {% data variables.product.product_location %} is running a release candidate build, you can't upgrade with a hotpatch.
|
||||
|
||||
- {% endif %}Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available in clustered environments. To install a hotpatch in a clustered environment, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)."
|
||||
@@ -233,7 +233,7 @@ For more information, see "[Command-line utilities](/enterprise/{{ currentVersio
|
||||
|
||||
To roll back from a feature release, restore from a VM snapshot to ensure that root and data partitions are in a consistent state. For more information, see "[Taking a snapshot](#taking-a-snapshot)."
|
||||
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
## Further reading
|
||||
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"
|
||||
|
||||
@@ -64,9 +64,6 @@ After you submit your support request, we may ask you to share a support bundle
|
||||
- `configuration-logs/ghe-config.log`: {% data variables.product.prodname_ghe_server %} configuration logs
|
||||
- `collectd/logs/collectd.log`: Collectd logs
|
||||
- `mail-logs/mail.log`: SMTP email delivery logs
|
||||
{% ifversion ghes < 3.0 %}
|
||||
- `hookshot-logs/exceptions.log`: Webhook delivery errors
|
||||
{% endif %}
|
||||
|
||||
For more information, see "[Audit logging](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)."
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Backing up and restoring GitHub Enterprise Server with GitHub Actions ena
|
||||
shortTitle: Backing up and restoring
|
||||
intro: '{% data variables.product.prodname_actions %} data on your external storage provider is not included in regular {% data variables.product.prodname_ghe_server %} backups, and must be backed up separately.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: High availability for GitHub Actions
|
||||
intro: 'There are some special considerations for administering {% data variables.product.prodname_actions %} in a high availability configuration.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Advanced configuration and troubleshooting
|
||||
intro: 'Configure high availability for {% data variables.product.prodname_actions %}, and troubleshoot {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
children:
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Troubleshooting GitHub Actions for your enterprise
|
||||
intro: 'Troubleshooting common issues that occur when using {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}.'
|
||||
permissions: 'Site administrators can troubleshoot {% data variables.product.prodname_actions %} issues and modify {% data variables.product.prodname_ghe_server %} configurations.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Using a staging environment
|
||||
intro: 'Learn about using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_ghe_server %} staging environments.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Enabling GitHub Actions with Amazon S3 storage
|
||||
intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use Amazon S3 storage to store artifacts generated by workflow runs.'
|
||||
permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Enabling GitHub Actions with Azure Blob storage
|
||||
intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use Azure Blob storage to store artifacts generated by workflow runs.'
|
||||
permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Enabling GitHub Actions with MinIO Gateway for NAS storage
|
||||
intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use MinIO Gateway for NAS storage to store artifacts generated by workflow runs.'
|
||||
permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -18,7 +18,7 @@ topics:
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
|
||||
This article explains how site administrators can configure {% data variables.product.prodname_ghe_server %} to use {% data variables.product.prodname_actions %}. It covers the hardware and software requirements, presents the storage options, and describes the security management policies.
|
||||
|
||||
@@ -26,11 +26,11 @@ This article explains how site administrators can configure {% data variables.pr
|
||||
|
||||
## Review hardware considerations
|
||||
|
||||
{% ifversion ghes = 2.22 or ghes = 3.0 %}
|
||||
{% ifversion ghes = 3.0 %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: {% ifversion ghes = 2.22 %}{% data variables.product.prodname_actions %} was available for {% data variables.product.prodname_ghe_server %} 2.22 as a limited beta. {% endif %}If you're upgrading an existing {% data variables.product.prodname_ghe_server %} instance to 3.0 or later and want to configure {% data variables.product.prodname_actions %}, note that the minimum hardware requirements have increased. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)."
|
||||
**Note**: If you're upgrading an existing {% data variables.product.prodname_ghe_server %} instance to 3.0 or later and want to configure {% data variables.product.prodname_actions %}, note that the minimum hardware requirements have increased. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
@@ -75,8 +75,7 @@ The peak quantity of concurrent jobs running without performance loss depends on
|
||||
|
||||
{%- endif %}
|
||||
|
||||
|
||||
If you {% ifversion ghes = 2.22 %}enabled the beta of{% else %}plan to enable{% endif %} {% data variables.product.prodname_actions %} for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)."
|
||||
If you plan to enable {% data variables.product.prodname_actions %} for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)."
|
||||
|
||||
For more information about minimum hardware requirements for {% data variables.product.product_location %}, see the hardware considerations for your instance's platform.
|
||||
|
||||
@@ -108,27 +107,11 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% ifversion ghes = 2.22 %}
|
||||
|
||||
### Amazon S3 permissions
|
||||
|
||||
{% data reusables.actions.enterprise-s3-permission %}
|
||||
|
||||
## Enabling {% data variables.product.prodname_actions %}
|
||||
|
||||
{% data variables.product.prodname_actions %} support on {% data variables.product.prodname_ghe_server %} 2.22 was available as a limited beta. To configure {% data variables.product.prodname_actions %} for your instance, upgrade to {% data variables.product.prodname_ghe_server %} 3.0 or later. For more information, see the [{% data variables.product.prodname_ghe_server %} 3.0 release notes](/enterprise-server@3.0/admin/release-notes) and "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server)."
|
||||
|
||||
## Further reading
|
||||
|
||||
- "Hardware considerations" for your platform in "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/installation/setting-up-a-github-enterprise-server-instance)"
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Networking considerations
|
||||
|
||||
{% data reusables.actions.proxy-considerations %} For more information about using a proxy with {% data variables.product.prodname_ghe_server %}, see "[Configuring an outbound web proxy server](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)."
|
||||
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
|
||||
## Enabling {% data variables.product.prodname_actions %} with your storage provider
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ redirect_from:
|
||||
- /admin/github-actions/about-using-actions-in-your-enterprise
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
type: overview
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -5,7 +5,7 @@ redirect_from:
|
||||
- /enterprise/admin/github-actions/managing-access-to-actions-from-githubcom
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
topics:
|
||||
- Enterprise
|
||||
children:
|
||||
|
||||
@@ -6,7 +6,7 @@ redirect_from:
|
||||
- /admin/github-actions/manually-syncing-actions-from-githubcom
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
type: tutorial
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -6,7 +6,7 @@ redirect_from:
|
||||
- /admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
type: tutorial
|
||||
topics:
|
||||
- Actions
|
||||
|
||||
@@ -137,5 +137,5 @@ Both primary and replica instances should be assigned separate EIPs in productio
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes > 2.22 %}
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %}
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %}
|
||||
|
||||
@@ -104,5 +104,5 @@ The {% data variables.product.prodname_ghe_server %} appliance requires a premiu
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes > 2.22 %}
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %}
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %}
|
||||
|
||||
@@ -97,5 +97,5 @@ To create the {% data variables.product.prodname_ghe_server %} instance, you'll
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes > 2.22 %}
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %}
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %}
|
||||
|
||||
@@ -69,5 +69,5 @@ shortTitle: Install on Hyper-V
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes > 2.22 %}
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %}
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %}
|
||||
|
||||
@@ -54,5 +54,5 @@ shortTitle: Install on OpenStack
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes > 2.22 %}
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %}
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %}
|
||||
|
||||
@@ -55,5 +55,5 @@ shortTitle: Install on VMware
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes > 2.22 %}
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %}
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %}
|
||||
|
||||
@@ -59,5 +59,5 @@ shortTitle: Install on XenServer
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes > 2.22 %}
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %}
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %}
|
||||
|
||||
@@ -31,7 +31,7 @@ To thoroughly test a {% data variables.product.prodname_ghe_server %} appliance
|
||||
2. Set up a new instance to act as your staging environment. You can use the same guides for provisioning and installing your staging instance as you did for your production instance. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance/)."
|
||||
3. Restore your backup onto your staging instance. For more information, see the "Restoring a backup" section of "[Configuring backups on your appliance](/enterprise/admin/guides/installation/configuring-backups-on-your-appliance#restoring-a-backup)."
|
||||
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
## Further reading
|
||||
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"
|
||||
|
||||
@@ -3,7 +3,7 @@ title: About upgrades to new releases
|
||||
shortTitle: About upgrades
|
||||
intro: '{% ifversion ghae %}Your enterprise on {% data variables.product.product_name %} is updated with the latest features and bug fixes on a regular basis by {% data variables.product.company_short %}.{% else %}You can benefit from new features and bug fixes for {% data variables.product.product_name %} by upgrading your enterprise to a newly released version.{% endif %}'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: overview
|
||||
topics:
|
||||
|
||||
@@ -19,9 +19,6 @@ shortTitle: Configure package ecosystems
|
||||
|
||||
To prevent new packages from being uploaded, you can set an ecosystem you previously enabled to **Read-Only**, while still allowing existing packages to be downloaded.
|
||||
|
||||
{% ifversion ghes = 2.22 %}
|
||||
To use {% data variables.product.prodname_registry %} with Docker, you must have subdomain isolation enabled for your instance. For more information, see "[Enabling subdomain isolation](/enterprise/admin/configuration/enabling-subdomain-isolation)."
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
|
||||
@@ -40,19 +40,8 @@ Ensure your AWS access key ID and secret have the following permissions:
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_site_admin_settings.packages-tab %}
|
||||
{% data reusables.package_registry.enable-enterprise-github-packages %}
|
||||
{% ifversion ghes = 2.22 %}
|
||||
1. Under "AWS Service URL", type the S3 endpoint URL for your bucket's region.
|
||||
|
||||
1. Under "AWS S3 Bucket", type the name of the S3 bucket you want to use to store package artifacts.
|
||||
|
||||
1. Under "AWS S3 Access Key", type your access key for S3.
|
||||
|
||||
1. Under "AWS S3 Secret Key", type your secret key for S3.
|
||||
|
||||
1. Under "AWS S3 Region", type your region for S3.
|
||||
|
||||
{% endif %}
|
||||
{% ifversion ghes > 2.22 %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
1. Under "Packages Storage", select **Amazon S3** and enter your storage bucket's details:
|
||||
- **AWS Service URL:** The service URL for your bucket. For example, if your S3 bucket was created in the `us-west-2 region`, this value should be `https://s3.us-west-2.amazonaws.com`.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Enabling GitHub Packages with Azure Blob Storage
|
||||
intro: 'Set up {% data variables.product.prodname_registry %} with Azure Blob Storage as your external storage.'
|
||||
versions:
|
||||
ghes: '>=3.0'
|
||||
ghes: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- Enterprise
|
||||
|
||||
@@ -33,25 +33,14 @@ Ensure your MinIO external storage access key ID and secret have these permissio
|
||||
|
||||
## Enabling {% data variables.product.prodname_registry %} with MinIO external storage
|
||||
|
||||
Although MinIO does not currently appear in the user interface under "Package Storage", MinIO is still {% ifversion ghes = 2.22 %} officially{% endif %} supported by {% data variables.product.prodname_registry %} on {% data variables.product.prodname_enterprise %}. Also, note that MinIO's object storage is compatible with the S3 API and you can enter MinIO's bucket details in place of AWS S3 details.
|
||||
Although MinIO does not currently appear in the user interface under "Package Storage", MinIO is still supported by {% data variables.product.prodname_registry %} on {% data variables.product.prodname_enterprise %}. Also, note that MinIO's object storage is compatible with the S3 API and you can enter MinIO's bucket details in place of AWS S3 details.
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_site_admin_settings.packages-tab %}
|
||||
{% data reusables.package_registry.enable-enterprise-github-packages %}
|
||||
{% ifversion ghes = 2.22 %}
|
||||
1. Under "AWS Service URL", type the MinIO URL for your bucket's region.
|
||||
|
||||
1. Under "AWS S3 Bucket", type the name of the MinIO bucket you want to use to store package artifacts.
|
||||
|
||||
1. Under "AWS S3 Access Key", type your access key for MinIO.
|
||||
|
||||
1. Under "AWS S3 Secret Key", type your secret key for MinIO.
|
||||
|
||||
1. Under "AWS S3 Region", type your region for MinIO.
|
||||
|
||||
{% endif %}
|
||||
{% ifversion ghes > 2.22 %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
1. Under "Packages Storage", select **Amazon S3**.
|
||||
1. Enter your MinIO storage bucket's details in the AWS storage settings.
|
||||
- **AWS Service URL:** The hosting URL for your MinIO bucket.
|
||||
|
||||
@@ -13,17 +13,6 @@ topics:
|
||||
- Packages
|
||||
---
|
||||
|
||||
{% ifversion ghes = 2.22 %}
|
||||
|
||||
{% data reusables.package_registry.packages-ghes-release-stage %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** After you've been invited to join the beta, follow the instructions from your account representative to enable {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.package_registry.packages-cluster-support %}
|
||||
|
||||
@@ -34,12 +23,12 @@ topics:
|
||||
After enabling {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, you'll need to prepare your third-party storage bucket. The amount of storage required depends on your usage of {% data variables.product.prodname_registry %}, and the setup guidelines can vary by storage provider.
|
||||
|
||||
Supported external storage providers
|
||||
- Amazon Web Services (AWS) S3 {% ifversion ghes > 2.22 %}
|
||||
- Amazon Web Services (AWS) S3 {% ifversion ghes %}
|
||||
- Azure Blob Storage {% endif %}
|
||||
- MinIO
|
||||
|
||||
To enable {% data variables.product.prodname_registry %} and configure third-party storage, see:
|
||||
- "[Enabling GitHub Packages with AWS](/admin/packages/enabling-github-packages-with-aws)"{% ifversion ghes > 2.22 %}
|
||||
- "[Enabling GitHub Packages with AWS](/admin/packages/enabling-github-packages-with-aws)"{% ifversion ghes %}
|
||||
- "[Enabling GitHub Packages with Azure Blob Storage](/admin/packages/enabling-github-packages-with-azure-blob-storage)"{% endif %}
|
||||
- "[Enabling GitHub Packages with MinIO](/admin/packages/enabling-github-packages-with-minio)"
|
||||
|
||||
@@ -49,6 +38,6 @@ Choose which package ecosystems you'd like to enable, disable, or set to read-on
|
||||
|
||||
## Step 3: Ensure you have a TLS certificate for your package host URL, if needed
|
||||
|
||||
If subdomain isolation is enabled for {% data variables.product.product_location %}{% ifversion ghes = 2.22 %}, which is required to use {% data variables.product.prodname_registry %} with Docker{% endif %}, you will need to create and upload a TLS certificate that allows the package host URL for each ecosystem you want to use, such as `npm.HOSTNAME`. Make sure each package host URL includes `https://`.
|
||||
If subdomain isolation is enabled for {% data variables.product.product_location %}, you will need to create and upload a TLS certificate that allows the package host URL for each ecosystem you want to use, such as `npm.HOSTNAME`. Make sure each package host URL includes `https://`.
|
||||
|
||||
You can create the certificate manually, or you can use _Let's Encrypt_. If you already use _Let's Encrypt_, you must request a new TLS certificate after enabling {% data variables.product.prodname_registry %}. For more information about package host URLs, see "[Enabling subdomain isolation](/enterprise/admin/configuration/enabling-subdomain-isolation)." For more information about uploading TLS certificates to {% data variables.product.product_name %}, see "[Configuring TLS](/enterprise/admin/configuration/configuring-tls)."
|
||||
|
||||
@@ -17,5 +17,5 @@ children:
|
||||
shortTitle: Manage GitHub Packages
|
||||
---
|
||||
{% data reusables.package_registry.packages-ghes-release-stage %}
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
{% endif %}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Enforcing policies for Advanced Security in your enterprise
|
||||
intro: "You can enforce policies to manage {% data variables.product.prodname_GH_advanced_security %} features within your enterprise's organizations, or allow policies to be set in each organization."
|
||||
intro: 'You can enforce policies to manage {% data variables.product.prodname_GH_advanced_security %} features within your enterprise''s organizations, or allow policies to be set in each organization.'
|
||||
permissions: 'Enterprise owners can enforce policies for {% data variables.product.prodname_GH_advanced_security %} in an enterprise.'
|
||||
product: '{% data reusables.gated-features.ghas %}'
|
||||
versions:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Enforcing policies for dependency insights in your enterprise
|
||||
intro: "You can enforce policies for dependency insights within your enterprise's organizations, or allow policies to be set in each organization."
|
||||
permissions: 'Enterprise owners can enforce policies for dependency insights in an enterprise.'
|
||||
intro: 'You can enforce policies for dependency insights within your enterprise''s organizations, or allow policies to be set in each organization.'
|
||||
permissions: Enterprise owners can enforce policies for dependency insights in an enterprise.
|
||||
product: '{% data reusables.gated-features.enterprise-accounts %}'
|
||||
redirect_from:
|
||||
- /articles/enforcing-a-policy-on-dependency-insights/
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Enforcing policies for GitHub Actions in your enterprise
|
||||
intro: "You can enforce policies for {% data variables.product.prodname_actions %} within your enterprise's organizations, or allow policies to be set in each organization."
|
||||
intro: 'You can enforce policies for {% data variables.product.prodname_actions %} within your enterprise''s organizations, or allow policies to be set in each organization.'
|
||||
permissions: 'Enterprise owners can enforce policies for {% data variables.product.prodname_actions %} in an enterprise.'
|
||||
miniTocMaxHeadingLevel: 3
|
||||
redirect_from:
|
||||
@@ -44,7 +44,7 @@ You can choose to disable {% data variables.product.prodname_actions %} for all
|
||||
{% data reusables.actions.enterprise-actions-permissions %}
|
||||
1. Click **Save**.
|
||||
|
||||
{% ifversion ghec or ghes > 2.22 or ghae %}
|
||||
{% ifversion ghec or ghes or ghae %}
|
||||
|
||||
### Allowing select actions to run
|
||||
|
||||
@@ -61,7 +61,7 @@ You can choose to disable {% data variables.product.prodname_actions %} for all
|
||||
{%- endif %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghec or ghes > 2.22 or ghae %}
|
||||
{% ifversion ghec or ghes or ghae %}
|
||||
|
||||
## Enforcing a policy for artifact and log retention in your enterprise
|
||||
|
||||
@@ -96,7 +96,7 @@ You can enforce policies to control how {% data variables.product.prodname_actio
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghec or ghes > 2.22 or ghae %}
|
||||
{% ifversion ghec or ghes or ghae %}
|
||||
|
||||
### Enforcing a policy for fork pull requests in private repositories
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Enforcing policies for security settings in your enterprise
|
||||
intro: "You can enforce policies to manage security settings in your enterprise's organizations, or allow policies to be set in each organization."
|
||||
permissions: 'Enterprise owners can enforce policies for security settings in an enterprise.'
|
||||
intro: 'You can enforce policies to manage security settings in your enterprise''s organizations, or allow policies to be set in each organization.'
|
||||
permissions: Enterprise owners can enforce policies for security settings in an enterprise.
|
||||
product: '{% data reusables.gated-features.enterprise-accounts %}'
|
||||
miniTocMaxHeadingLevel: 3
|
||||
redirect_from:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Enforcing project board policies in your enterprise
|
||||
intro: "You can enforce policies for projects within your enterprise's organizations, or allow policies to be set in each organization."
|
||||
permissions: 'Enterprise owners can enforce policies for project boards in an enterprise.'
|
||||
intro: 'You can enforce policies for projects within your enterprise''s organizations, or allow policies to be set in each organization.'
|
||||
permissions: Enterprise owners can enforce policies for project boards in an enterprise.
|
||||
product: '{% data reusables.gated-features.enterprise-accounts %}'
|
||||
redirect_from:
|
||||
- /articles/enforcing-project-board-settings-for-organizations-in-your-business-account/
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Enforcing repository management policies in your enterprise
|
||||
intro: "You can enforce policies for repository management within your enterprise's organizations, or allow policies to be set in each organization."
|
||||
permissions: 'Enterprise owners can enforce policies for repository management in an enterprise.'
|
||||
intro: 'You can enforce policies for repository management within your enterprise''s organizations, or allow policies to be set in each organization.'
|
||||
permissions: Enterprise owners can enforce policies for repository management in an enterprise.
|
||||
product: '{% data reusables.gated-features.enterprise-accounts %}'
|
||||
redirect_from:
|
||||
- /enterprise/admin/installation/configuring-the-default-visibility-of-new-repositories-on-your-appliance
|
||||
@@ -132,7 +132,7 @@ Across all organizations owned by your enterprise, you can allow members to invi
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghec or ghes > 2.22 or ghae %}
|
||||
{% ifversion ghec or ghes or ghae %}
|
||||
|
||||
## Enforcing a policy for the default branch name
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Enforcing team policies in your enterprise
|
||||
intro: "You can enforce policies for teams in your enterprise's organizations, or allow policies to be set in each organization."
|
||||
permissions: 'Enterprise owners can enforce policies for teams in an enterprise.'
|
||||
intro: 'You can enforce policies for teams in your enterprise''s organizations, or allow policies to be set in each organization.'
|
||||
permissions: Enterprise owners can enforce policies for teams in an enterprise.
|
||||
product: '{% data reusables.gated-features.enterprise-accounts %}'
|
||||
redirect_from:
|
||||
- /articles/enforcing-team-settings-for-organizations-in-your-business-account/
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Streaming the audit logs for organizations in your enterprise account
|
||||
intro: Enterprise owners can stream audit and Git events data from {% data variables.product.prodname_dotcom %} to an external data management system.
|
||||
intro: 'Enterprise owners can stream audit and Git events data from {% data variables.product.prodname_dotcom %} to an external data management system.'
|
||||
product: '{% data reusables.gated-features.enterprise-accounts %}'
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
|
||||
@@ -39,7 +39,7 @@ If you don't have private mode enabled, the migration script will have no effect
|
||||
## Running the migration
|
||||
|
||||
1. Connect to the administrative shell. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/admin/installation/accessing-the-administrative-shell-ssh)."
|
||||
{% ifversion ghes > 2.22 or ghae %}
|
||||
{% ifversion ghes or ghae %}
|
||||
2. Run the migration command.
|
||||
```shell
|
||||
github-env bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log
|
||||
|
||||
@@ -18,7 +18,7 @@ topics:
|
||||
## About user messages
|
||||
|
||||
There are several types of user messages.
|
||||
- Messages that appear on the {% ifversion ghes %}sign in or {% endif %}sign out page{% ifversion ghes > 2.22 or ghae %}
|
||||
- Messages that appear on the {% ifversion ghes %}sign in or {% endif %}sign out page{% ifversion ghes or ghae %}
|
||||
- Mandatory messages, which appear once in a pop-up window that must be dismissed{% endif %}{% ifversion ghes or ghae %}
|
||||
- Announcement banners, which appear at the top of every page{% endif %}
|
||||
|
||||
@@ -36,10 +36,10 @@ You can use Markdown to format your message. For more information, see "[About w
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.messages-tab %}
|
||||
5. {% ifversion ghes > 2.22 %}To the right of{% else %}Under{% endif %} "Sign in page", click **Add message** or **Edit message**.
|
||||
|
||||
5. {% ifversion ghes %}To the right of{% else %}Under{% endif %} "Sign in page", click **Add message** or **Edit message**.
|
||||
|
||||
6. Under **Sign in message**, type the message you'd like users to see.
|
||||
{% ifversion ghes > 2.22 %}
|
||||
{% ifversion ghes %}
|
||||
{% data reusables.enterprise_site_admin_settings.message-preview-save %}{% else %}
|
||||
{% data reusables.enterprise_site_admin_settings.click-preview %}
|
||||
|
||||
@@ -53,10 +53,10 @@ You can use Markdown to format your message. For more information, see "[About w
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.messages-tab %}
|
||||
5. {% ifversion ghes > 2.22 or ghae %}To the right of{% else %}Under{% endif %} "Sign out page", click **Add message** or **Edit message**.
|
||||
5. {% ifversion ghes or ghae %}To the right of{% else %}Under{% endif %} "Sign out page", click **Add message** or **Edit message**.
|
||||
|
||||
6. Under **Sign out message**, type the message you'd like users to see.
|
||||
{% ifversion ghes > 2.22 or ghae %}
|
||||
{% ifversion ghes or ghae %}
|
||||
{% data reusables.enterprise_site_admin_settings.message-preview-save %}{% else %}
|
||||
{% data reusables.enterprise_site_admin_settings.click-preview %}
|
||||
|
||||
@@ -64,7 +64,7 @@ You can use Markdown to format your message. For more information, see "[About w
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.save-changes %}{% endif %}
|
||||
|
||||
{% ifversion ghes > 2.22 or ghae %}
|
||||
{% ifversion ghes or ghae %}
|
||||
## Creating a mandatory message
|
||||
|
||||
You can create a mandatory message that {% data variables.product.product_name %} will show to all users the first time they sign in after you save the message. The message appears in a pop-up window that the user must dismiss before the user can use {% data variables.product.product_location %}.
|
||||
@@ -101,7 +101,7 @@ Each time a user sees a mandatory message, an audit log event is created. The ev
|
||||
|
||||
You can set a global announcement banner to be displayed to all users at the top of every page.
|
||||
|
||||
{% ifversion ghae or ghes > 2.22 %}
|
||||
{% ifversion ghae or ghes %}
|
||||
You can also set an announcement banner{% ifversion ghes %} in the administrative shell using a command line utility or{% endif %} using the API. For more information, see {% ifversion ghes %}"[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-announce)" and {% endif %}"[{% data variables.product.prodname_enterprise %} administration](/rest/reference/enterprise-admin#announcements)."
|
||||
{% else %}
|
||||
|
||||
@@ -112,7 +112,7 @@ You can also set an announcement banner in the administrative shell using a comm
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.messages-tab %}
|
||||
1. {% ifversion ghes > 2.22 or ghae %}To the right of{% else %}Under{% endif %} "Announcement", click **Add announcement**.
|
||||
1. {% ifversion ghes or ghae %}To the right of{% else %}Under{% endif %} "Announcement", click **Add announcement**.
|
||||
|
||||
1. Under "Announcement", in the text field, type the announcement you want displayed in a banner.
|
||||
|
||||
|
||||
@@ -91,7 +91,6 @@ Action | Description
|
||||
`issue_comment.update` | A comment on an issue (other than the initial one) changed.
|
||||
`issue.destroy` | An issue was deleted from the repository. For more information, see "[Deleting an issue](/github/managing-your-work-on-github/deleting-an-issue)."
|
||||
|
||||
|
||||
## Organizations
|
||||
|
||||
Action | Description
|
||||
@@ -170,9 +169,9 @@ Action | Description
|
||||
Action | Description
|
||||
--------------------------------- | -------------------------------------------
|
||||
`team.create` | A user account or repository was added to a team.
|
||||
`team.delete` | A user account or repository was removed from a team.{% ifversion ghes > 2.22 or ghae %}
|
||||
`team.delete` | A user account or repository was removed from a team.{% ifversion ghes or ghae %}
|
||||
`team.demote_maintainer` | A user was demoted from a team maintainer to a team member.{% endif %}
|
||||
`team.destroy` | A team was deleted.{% ifversion ghes > 2.22 or ghae %}
|
||||
`team.destroy` | A team was deleted.{% ifversion ghes or ghae %}
|
||||
`team.promote_maintainer` | A user was promoted from a team member to a team maintainer.{% endif %}
|
||||
|
||||
## Users
|
||||
@@ -188,7 +187,7 @@ Action | Description
|
||||
`user.destroy` | A user deleted his or her account, triggering `user.async_delete`.{% ifversion ghes %}
|
||||
`user.failed_login` | A user tried to sign in with an incorrect username, password, or two-factor authentication code.
|
||||
`user.forgot_password` | A user requested a password reset via the sign-in page.{% endif %}
|
||||
`user.login` | A user signed in.{% ifversion ghes > 2.22 or ghae %}
|
||||
`user.login` | A user signed in.{% ifversion ghes or ghae %}
|
||||
`user.mandatory_message_viewed` | A user views a mandatory message (see "[Customizing user messages](/admin/user-management/customizing-user-messages-for-your-enterprise)" for details) | {% endif %}
|
||||
`user.promote` | An ordinary user account was promoted to a site admin.
|
||||
`user.remove_email` | An email address was removed from a user account.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
title: Managing global webhooks
|
||||
shortTitle: Manage global webhooks
|
||||
intro: 'You can configure global webhooks to notify external web servers when events occur within your enterprise.'
|
||||
permissions: 'Enterprise owners can manage global webhooks for an enterprise account.'
|
||||
intro: You can configure global webhooks to notify external web servers when events occur within your enterprise.
|
||||
permissions: Enterprise owners can manage global webhooks for an enterprise account.
|
||||
redirect_from:
|
||||
- /enterprise/admin/user-management/about-global-webhooks
|
||||
- /enterprise/admin/user-management/managing-global-webhooks
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user