jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-25 02:17:36 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into openapi-update-3b559f2de62c2da2509a0339485fd47642f5800984361cc69c29ce15203f40fe

Browse Source
This commit is contained in:
Sarita Iyer
2021-12-07 10:46:39 -05:00
committed by GitHub
parent 75f07228c9 2c0ead55f3
commit bb54376928
490 changed files with 3722 additions and 5083 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
.github/workflows/sync-search-pr.yml vendored Normal file
View File

@@ -0,0 +1,40 @@
name: Sync search - PR
# **What it does**: Tries running the sync-search when relevant files change.
# **Why we have it**: To test that the script works and the popular pages json is valid.
# **Who does it impact**: Docs engineering.
on:
pull_request:
paths:
- script/search/parse-page-sections-into-records.js
- script/search/popular-pages.js
- lib/search/popular-pages.json
# Ultimately, for debugging this workflow itself
- .github/workflows/sync-search-pr.yml
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
- name: Setup node
uses: actions/setup-node@04c56d2f954f1e4c69436aa54cfef261a018f458
with:
node-version: 16.13.x
cache: npm
- name: Install dependencies
run: npm ci
- name: Build
run: npm run build
- name: Run sync-search
env:
# Set filtered to only these so it doesn't run for too long.
LANGUAGE: en
VERSION: free-pro-team@latest
run: npm run sync-search

BIN
assets/images/azure/github-ae-azure-portal-add-new.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
assets/images/azure/github-ae-azure-portal-all-resources.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
assets/images/azure/github-ae-azure-portal-form.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 102 KiB

BIN
assets/images/azure/github-ae-azure-portal-search.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
assets/images/azure/github-ae-azure-portal-type-filter.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 66 KiB

BIN
assets/images/help/enterprises/organization-search.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 35 KiB

BIN
assets/images/help/enterprises/remove-organization-warning.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

BIN
assets/images/help/enterprises/remove-organization.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 44 KiB

6
components/release-notes/GHAEReleaseNotePatch.tsx
View File

@@ -16,9 +16,7 @@ export function GHAEReleaseNotePatch({ patch, didEnterView }: Props) {
}
}, [onScreen])
const bannerText = patch.currentWeek
? t('banner_text_current')
: `${t('banner_text_past')} ${patch.friendlyDate}.`
const bannerText = t('banner_text')
return (
<div
@@ -45,7 +43,7 @@ export function GHAEReleaseNotePatch({ patch, didEnterView }: Props) {
<button className="js-print btn-link ml-3 text-small text-bold">Print</button>
</div>
<p className="color-fg-muted mt-1">
{patch.friendlyDate} - {bannerText}
{bannerText} {patch.friendlyDate}.
</p>
</header>

2
components/release-notes/GHAEReleaseNotes.tsx
View File

@@ -85,7 +85,7 @@ const CollapsibleReleaseSection = ({
{release.version}
<div className="d-flex">
<span className="color-fg-muted text-small text-normal mr-1">
{release.patches.length} releases
{release.patches.length} {release.patches.length === 1 ? 'release' : 'releases'}
</span>
<ChevronDownIcon className={isOpen ? 'rotate-180' : ''} />
</div>

2
components/release-notes/GHESReleaseNotes.tsx
View File

@@ -166,7 +166,7 @@ const CollapsibleReleaseSection = ({
{release.version}
<div className="d-flex">
<span className="color-fg-muted text-small text-normal mr-1">
{release.patches.length} releases
{release.patches.length} {release.patches.length === 1 ? 'release' : 'releases'}
</span>
<ChevronDownIcon className={isOpen ? 'rotate-180' : ''} />
</div>

6
components/release-notes/PatchNotes.tsx
View File

@@ -93,11 +93,7 @@ export function PatchNotes({ patch, withReleaseNoteLabel }: Props) {
</h4>
{item.notes.map((note) => {
return (
<li
key={note}
className={cx(!withReleaseNoteLabel && 'list-style-none', 'f4')}
dangerouslySetInnerHTML={{ __html: note }}
/>
<li key={note} className="f4" dangerouslySetInnerHTML={{ __html: note }} />
)
})}
</Fragment>

2
content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md
View File

@@ -65,7 +65,7 @@ When you unwatch a repository, you unsubscribe from future updates from that rep
1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down to click **Watched repositories**.
![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png)
2. On the watched repositories page, after you've evaluated the repositories you're watching, choose whether to:
{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
- Unwatch a repository
- Ignore all notifications for a repository
- Customize the types of event you receive notifications for ({% data reusables.notifications-v2.custom-notification-types %}, if enabled)

6
content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md
View File

@@ -38,7 +38,7 @@ When your inbox has too many notifications to manage, consider whether you have
For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#automatic-watching)."
To see an overview of your repository subscriptions, see "[Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching)."
{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
{% tip %}
**Tip:** You can select the types of event to be notified of by using the **Custom** option of the **Watch/Unwatch** dropdown list in your [watching page](https://github.com/watching) or on any repository page on {% data variables.product.product_name %}. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)."
@@ -72,7 +72,7 @@ Many people forget about repositories that they've chosen to watch in the past.
1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down menu and click **Watched repositories**.
![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png)
2. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository.
{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
![Watched notifications page](/assets/images/help/notifications-v2/watched-notifications-custom.png)
{% else %}
![Watched notifications page](/assets/images/help/notifications-v2/watched-notifications.png)
@@ -80,7 +80,7 @@ Many people forget about repositories that they've chosen to watch in the past.
{% tip %}
**Tip:** Instead of watching a repository, consider only receiving notifications {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}when there are updates to {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository), or any combination of these options,{% else %}for releases in a repository,{% endif %} or completely unwatching a repository.
**Tip:** Instead of watching a repository, consider only receiving notifications {% ifversion fpt or ghes > 3.0 or ghae or ghec %}when there are updates to {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository), or any combination of these options,{% else %}for releases in a repository,{% endif %} or completely unwatching a repository.
When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you configure to receive notifications for certain event types, you're only notified when there are updates to these event types in the repository, you're participating in a thread, or you or a team you're on is @mentioned.

2
content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md
View File

@@ -28,7 +28,7 @@ You can choose to receive ongoing updates about specific activity on {% data var
You can choose to subscribe to notifications for:
- A conversation in a specific issue, pull request, or gist.
- All activity in a repository or team discussion.
- CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}. {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
- CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}
- Repository {% data reusables.notifications-v2.custom-notification-types %} (if enabled).{% else %}
- Releases in a repository.{% endif %}

4
content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md
View File

@@ -76,7 +76,7 @@ To see repositories that you're watching, go to your [watching page](https://git
{% endif %}
You can configure notifications for a repository on the repository page, or on your watching page.{% ifversion ghes < 3.1 %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %}
{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
### About custom notifications
You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events ({% data reusables.notifications-v2.custom-notification-types %}) happen within a repository, or ignore all notifications for a repository.
@@ -160,7 +160,7 @@ If "Automatically watch repositories" is disabled, then you will not automatical
## Configuring your watch settings for an individual repository
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}certain event types such as {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository) {% else %}new releases{% endif %}, or completely ignore an individual repository.
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghes > 3.0 or ghae or ghec %}certain event types such as {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository) {% else %}new releases{% endif %}, or completely ignore an individual repository.
{% data reusables.repositories.navigate-to-repo %}
2. In the upper-right corner, select the "Watch" drop-down menu to click a watch option.

14
content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md
View File

@@ -10,7 +10,7 @@ redirect_from:
versions:
fpt: '*'
ghes: '*'
ghae: next
ghae: '*'
ghec: '*'
topics:
- Profiles
@@ -19,7 +19,7 @@ shortTitle: Send enterprise contributions
## About enterprise contributions on your {% data variables.product.prodname_dotcom_the_website %} profile
Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %}<!-- Remove condition entirely when toggling feature flag --> or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% data variables.product.prodname_enterprise %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}.
Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% else %}{% data variables.product.product_name %}{% endif %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}.
You can decide whether to show counts for private contributions on your profile. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile/)."
@@ -30,18 +30,16 @@ For more information about how contributions are calculated, see "[Managing cont
**Notes:**
- The connection between your accounts is governed by <a href="/articles/github-privacy-statement/" class="dotcom-only">GitHub's Privacy Statement</a> and users enabling the connection agree to the <a href="/articles/github-terms-of-service/" class="dotcom-only">GitHub's Terms of Service</a>.
- Before you can connect your {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %}<!-- Remove condition entirely when toggling feature flag --> or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} profile to your {% data variables.product.prodname_dotcom_the_website %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. For more information, contact your enterprise owner.
- Before you can connect your {% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% else %}{% data variables.product.product_name %}{% endif %} profile to your {% data variables.product.prodname_dotcom_the_website %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. For more information, contact your enterprise owner.
{% endnote %}
{% ifversion fpt or ghes or ghae or ghec %}
## Sending your enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile
{% ifversion fpt or ghec %}
- To send enterprise contributions from {% data variables.product.prodname_ghe_server %} to your {% data variables.product.prodname_dotcom_the_website %} profile, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/enterprise-server/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" in the {% data variables.product.prodname_ghe_server %} documentation.{% ifversion ghae-next %}<!-- Condition is within an fpt block; remove condition entirely when toggling feature flag -->
- To send enterprise contributions from {% data variables.product.prodname_ghe_managed %} to your {% data variables.product.prodname_dotcom_the_website %} profile, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" in the {% data variables.product.prodname_ghe_managed %} documentation.{% endif %}
- To send enterprise contributions from {% data variables.product.prodname_ghe_server %} to your {% data variables.product.prodname_dotcom_the_website %} profile, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/enterprise-server/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" in the {% data variables.product.prodname_ghe_server %} documentation.
- To send enterprise contributions from {% data variables.product.prodname_ghe_managed %} to your {% data variables.product.prodname_dotcom_the_website %} profile, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" in the {% data variables.product.prodname_ghe_managed %} documentation.
{% elsif ghes %}
@@ -65,5 +63,3 @@ For more information about how contributions are calculated, see "[Managing cont
{% data reusables.github-connect.send-contribution-counts-to-githubcom %}
{% endif %}
{% endif %}

4
content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md
View File

@@ -91,11 +91,11 @@ The contribution activity section includes a detailed timeline of your work, inc
![Contribution activity time filter](/assets/images/help/profile/contributions_activity_time_filter.png)
{% ifversion fpt or ghes or ghae-next or ghec %}
{% ifversion fpt or ghes or ghae or ghec %}
## Viewing contributions from {% data variables.product.prodname_enterprise %} on {% data variables.product.prodname_dotcom_the_website %}
If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.product.prodname_unified_contributions %}, you can send enterprise contribution counts from to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)."
If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.product.prodname_unified_contributions %}, you can send enterprise contribution counts from to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)."
{% endif %}

2
content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md
View File

@@ -3,7 +3,7 @@ title: Managing your theme settings
intro: 'You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses a light or dark mode.'
versions:
fpt: '*'
ghae: next
ghae: '*'
ghes: '>=3.2'
ghec: '*'
topics:

4
content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md
View File

@@ -34,7 +34,7 @@ The repository owner has full control of the repository. In addition to the acti
| :- | :- |
| {% ifversion fpt or ghec %}Invite collaborators{% else %}Add collaborators{% endif %} | "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" |
| Change the visibility of the repository | "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" |{% ifversion fpt or ghec %}
| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
| Rename a branch, including the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %}
| Merge a pull request on a protected branch, even if there are no approving reviews | "[About protected branches](/github/administering-a-repository/about-protected-branches)" |
| Delete the repository | "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)" |
@@ -68,7 +68,7 @@ Collaborators can also perform the following actions.
| Action | More information |
| :- | :- |
| Fork the repository | "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
| Fork the repository | "[About forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)" |{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
| Rename a branch other than the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %}
| Create, edit, and delete comments on commits, pull requests, and issues in the repository | <ul><li>"[About issues](/github/managing-your-work-on-github/about-issues)"</li><li>"[Commenting on a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"</li><li>"[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"</li></ul> |
| Create, assign, close, and re-open issues in the repository | "[Managing your work with issues](/github/managing-your-work-on-github/managing-your-work-with-issues)" |

1
content/actions/advanced-guides/index.md
View File

@@ -15,4 +15,3 @@ children:
- /using-github-cli-in-workflows
---
{% data reusables.actions.ae-beta %}

1
content/actions/advanced-guides/storing-workflow-data-as-artifacts.md
View File

@@ -20,7 +20,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About workflow artifacts

1
content/actions/advanced-guides/using-github-cli-in-workflows.md
View File

@@ -15,7 +15,6 @@ topics:
type: how_to
---
{% data reusables.actions.ae-beta %}
{% data reusables.cli.cli-learn-more %}

3
content/actions/automating-builds-and-tests/about-continuous-integration.md
View File

@@ -20,7 +20,6 @@ shortTitle: Continuous integration
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About continuous integration
@@ -32,7 +31,7 @@ Building and testing your code requires a server. You can build and test updates
## About continuous integration using {% data variables.product.prodname_actions %}
{% ifversion ghae %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on virtual machines hosted by {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)."
{% ifversion ghae %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on runner systems that you host. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)."
{% else %} CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)."
{% endif %}

4
content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md
View File

@@ -19,13 +19,13 @@ shortTitle: Build & test Java & Ant
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Ant build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to upload artifacts from a workflow run.
{% 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)."
{% ifversion ghae %}
{% data reusables.actions.self-hosted-runners-software %}
{% else %}
{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Ant. For a list of software and the pre-installed versions for JDK and Ant, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)".
{% endif %}

4
content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md
View File

@@ -19,13 +19,13 @@ shortTitle: Build & test Java & Gradle
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Gradle build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to cache files and upload artifacts from a workflow run.
{% 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)."
{% ifversion ghae %}
{% data reusables.actions.self-hosted-runners-software %}
{% else %}
{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Gradle. For a list of software and the pre-installed versions for JDK and Gradle, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)".
{% endif %}

4
content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md
View File

@@ -19,13 +19,13 @@ shortTitle: Build & test Java with Maven
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Maven software project management tool. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to cache files and upload artifacts from a workflow run.
{% 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)."
{% ifversion ghae %}
{% data reusables.actions.self-hosted-runners-software %}
{% else %}
{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Maven. For a list of software and the pre-installed versions for JDK and Maven, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)".
{% endif %}

5
content/actions/automating-builds-and-tests/building-and-testing-net.md
View File

@@ -13,13 +13,12 @@ shortTitle: Build & test .NET
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
This guide shows you how to build, test, and publish a .NET package.
{% ifversion ghae %} To build and test your .NET project on {% data variables.product.prodname_ghe_managed %}, you will need to create a custom operating system image that includes the .NET Core SDK. 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)."
{% ifversion ghae %} To build and test your .NET project on {% data variables.product.prodname_ghe_managed %}, the .NET Core SDK is required. {% data reusables.actions.self-hosted-runners-software %}
{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the .NET Core SDK. For a full list of up-to-date software and the preinstalled versions of .NET Core SDK, see [software installed on {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners).
{% endif %}
@@ -239,7 +238,7 @@ on:
jobs:
deploy:
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
permissions:
packages: write
contents: read{% endif %}

1
content/actions/automating-builds-and-tests/building-and-testing-nodejs-or-python.md
View File

@@ -14,6 +14,5 @@ topics:
- CI
---
{% data reusables.actions.ae-beta %}
<!-- This article is specially rendered via the pages/ directory -->

3
content/actions/automating-builds-and-tests/building-and-testing-nodejs.md
View File

@@ -22,7 +22,6 @@ hasExperimentalAlternative: true
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -135,7 +134,7 @@ jobs:
{% endraw %}
If you don't specify a Node.js version, {% data variables.product.prodname_dotcom %} uses the environment's default Node.js version.
{% 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)."
{% ifversion ghae %} {% data reusables.actions.self-hosted-runners-software %}
{% else %} For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)".
{% endif %}

4
content/actions/automating-builds-and-tests/building-and-testing-powershell.md
View File

@@ -19,7 +19,6 @@ shortTitle: Build & test PowerShell
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -27,7 +26,8 @@ This guide shows you how to use PowerShell for CI. It describes how to use Peste
{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes PowerShell and Pester.
{% 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)."
{% ifversion ghae %}
{% data reusables.actions.self-hosted-runners-software %}
{% else %}For a full list of up-to-date software and the pre-installed versions of PowerShell and Pester, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)".
{% endif %}

4
content/actions/automating-builds-and-tests/building-and-testing-python.md
View File

@@ -21,13 +21,13 @@ hasExperimentalAlternative: true
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
This guide shows you how to build, test, and publish a Python package.
{% 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)."
{% ifversion ghae %}
{% data reusables.actions.self-hosted-runners-software %}
{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)".
{% endif %}

3
content/actions/automating-builds-and-tests/building-and-testing-ruby.md
View File

@@ -17,7 +17,6 @@ shortTitle: Build & test Ruby
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -284,7 +283,7 @@ on:
jobs:
build:
name: Build + Publish
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
permissions:
packages: write
contents: read{% endif %}

3
content/actions/automating-builds-and-tests/building-and-testing-swift.md
View File

@@ -17,13 +17,12 @@ shortTitle: Build & test Swift
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
This guide shows you how to build and test a Swift package.
{% ifversion ghae %} To build and test your Swift project on {% data variables.product.prodname_ghe_managed %}, you will need to create a custom operating system image that includes the necessary Swift dependencies. 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)."
{% ifversion ghae %} To build and test your Swift project on {% data variables.product.prodname_ghe_managed %}, the necessary Swift dependencies are required. {% data reusables.actions.self-hosted-runners-software %}
{% else %}{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, and the Ubuntu and macOS runners include the dependencies for building Swift packages. For a full list of up-to-date software and the preinstalled versions of Swift and Xcode, see "[About GitHub-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)."{% endif %}
## Prerequisites

1
content/actions/automating-builds-and-tests/building-and-testing-xamarin-applications.md
View File

@@ -21,7 +21,6 @@ shortTitle: Build & test Xamarin apps
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

1
content/actions/automating-builds-and-tests/index.md
View File

@@ -29,4 +29,3 @@ children:
- /building-and-testing-xamarin-applications
---
{% data reusables.actions.ae-beta %}

1
content/actions/creating-actions/about-custom-actions.md
View File

@@ -20,7 +20,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About custom actions

1
content/actions/creating-actions/creating-a-composite-action.md
View File

@@ -16,7 +16,6 @@ shortTitle: Composite action
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

1
content/actions/creating-actions/creating-a-docker-container-action.md
View File

@@ -20,7 +20,6 @@ shortTitle: Docker container action
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

1
content/actions/creating-actions/creating-a-javascript-action.md
View File

@@ -20,7 +20,6 @@ shortTitle: JavaScript action
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

1
content/actions/creating-actions/dockerfile-support-for-github-actions.md
View File

@@ -14,7 +14,6 @@ type: reference
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About Dockerfile instructions

1
content/actions/creating-actions/index.md
View File

@@ -26,4 +26,3 @@ children:
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}

1
content/actions/creating-actions/metadata-syntax-for-github-actions.md
View File

@@ -17,7 +17,6 @@ type: reference
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About YAML syntax for {% data variables.product.prodname_actions %}

1
content/actions/creating-actions/setting-exit-codes-for-actions.md
View File

@@ -14,7 +14,6 @@ type: how_to
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About exit codes

3
content/actions/deployment/about-deployments/about-continuous-deployment.md
View File

@@ -16,7 +16,6 @@ shortTitle: About continuous deployment
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About continuous deployment
@@ -31,7 +30,7 @@ You can set up a {% data variables.product.prodname_actions %} workflow to deplo
You can configure your CD workflow to run when a {% data variables.product.product_name %} event occurs (for example, when new code is pushed to the default branch of your repository), on a set schedule, manually, or when an external event occurs using the repository dispatch webhook. For more information about when your workflow can run, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)."
{% ifversion fpt or ghae or ghes > 3.0 or ghec %}
{% data variables.product.prodname_actions %} provides features that give you more control over deployments. For example, you can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, or limit access to secrets. {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can use concurrency to limit your CD pipeline to a maximum of one in-progress deployment and one pending deployment. {% endif %}For more information about these features, see "[Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)" and "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."{% endif %}
{% data variables.product.prodname_actions %} provides features that give you more control over deployments. For example, you can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, or limit access to secrets. {% ifversion fpt or ghae or ghes > 3.1 or ghec %}You can use concurrency to limit your CD pipeline to a maximum of one in-progress deployment and one pending deployment. {% endif %}For more information about these features, see "[Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)" and "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."{% endif %}
{% ifversion fpt or ghec or ghae-issue-4856 %}

1
content/actions/deployment/about-deployments/deploying-with-github-actions.md
View File

@@ -16,7 +16,6 @@ shortTitle: Deploy with GitHub Actions
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

1
content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-amazon-elastic-container-service.md
View File

@@ -19,7 +19,6 @@ shortTitle: Deploy to Amazon ECS
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

1
content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure-app-service.md
View File

@@ -19,7 +19,6 @@ shortTitle: Deploy to Azure App Service
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

1
content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-google-kubernetes-engine.md
View File

@@ -19,7 +19,6 @@ shortTitle: Deploy to Google Kubernetes Engine
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

1
content/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development.md
View File

@@ -18,7 +18,6 @@ shortTitle: Sign Xcode applications
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

1
content/actions/deployment/index.md
View File

@@ -16,4 +16,3 @@ children:
- /deploying-xcode-applications
---
{% data reusables.actions.ae-beta %}

1
content/actions/deployment/managing-your-deployments/viewing-deployment-history.md
View File

@@ -14,7 +14,6 @@ redirect_from:
- /actions/deployment/viewing-deployment-history
---
{% data reusables.actions.ae-beta %}
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)."

9
content/actions/deployment/targeting-different-environments/using-environments-for-deployment.md
View File

@@ -15,7 +15,6 @@ versions:
ghec: '*'
---
{% data reusables.actions.ae-beta %}
## About environments
@@ -35,7 +34,7 @@ Organizations that use {% data variables.product.prodname_ghe_cloud %} can confi
## Environment protection rules
Environment protection rules require specific conditions to pass before a job referencing the environment can proceed. {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can use environment protection rules to require a manual approval, delay a job, or restrict the environment to certain branches.{% else %}You can use environment protection rules to require a manual approval or delay a job.{% endif %}
Environment protection rules require specific conditions to pass before a job referencing the environment can proceed. {% ifversion fpt or ghae or ghes > 3.1 or ghec %}You can use environment protection rules to require a manual approval, delay a job, or restrict the environment to certain branches.{% else %}You can use environment protection rules to require a manual approval or delay a job.{% endif %}
### Required reviewers
@@ -47,7 +46,7 @@ For more information on reviewing jobs that reference an environment with requir
Use a wait timer to delay a job for a specific amount of time after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}
{% ifversion fpt or ghae or ghes > 3.1 or ghec %}
### Deployment branches
Use deployment branches to restrict which branches can deploy to the environment. Below are the options for deployment branches for an environment:
@@ -94,7 +93,7 @@ Secrets stored in an environment are only available to workflow jobs that refere
1. Enter the secret value.
1. Click **Add secret**.
{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can also create and configure environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)" and "[Secrets](/rest/reference/actions#secrets)."{% endif %}
{% ifversion fpt or ghae or ghes > 3.1 or ghec %}You can also create and configure environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)" and "[Secrets](/rest/reference/actions#secrets)."{% endif %}
Running a workflow that references an environment that does not exist will create an environment with the referenced name. The newly created environment will not have any protection rules or secrets configured. Anyone that can edit workflows in the repository can create environments via a workflow file, but only repository admins can configure the environment.
@@ -118,7 +117,7 @@ Deleting an environment will delete all secrets and protection rules associated
1. Next to the environment that you want to delete, click {% octicon "trash" aria-label="The trash icon" %}.
2. Click **I understand, delete this environment**.
{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can also delete environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)."{% endif %}
{% ifversion fpt or ghae or ghes > 3.1 or ghec %}You can also delete environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)."{% endif %}
## How environments relate to deployments

21
content/actions/hosting-your-own-runners/about-self-hosted-runners.md
View File

@@ -15,7 +15,6 @@ type: overview
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About self-hosted runners
@@ -32,17 +31,19 @@ Your runner machine connects to {% data variables.product.product_name %} using
For more information about installing and using self-hosted runners, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)."
## Differences between {% data variables.product.prodname_dotcom %}-hosted and self-hosted runners
## {% ifversion fpt or ghes %}Differences between {% data variables.product.prodname_dotcom %}-hosted and {% elsif ghae %}Characteristics of {% endif %}self-hosted runners
{% data variables.product.prodname_dotcom %}-hosted runners offer a quicker, simpler way to run your workflows, while self-hosted runners are a highly configurable way to run workflows in your own custom environment.
{% ifversion fpt or ghes %}
{% data variables.product.prodname_dotcom %}-hosted runners offer a quicker, simpler way to run your workflows, while self-hosted{% elsif ghae %}Self-hosted{% endif %} runners are a highly configurable way to run workflows in your own custom environment. {% ifversion ghae %}Self-hosted runners:{% endif %}
{% ifversion fpt or ghes %}
**{% data variables.product.prodname_dotcom %}-hosted runners:**
- Receive automatic updates for the operating system, preinstalled packages and tools, and the self-hosted runner application.
- Are managed and maintained by {% data variables.product.prodname_dotcom %}.
- Provide a clean instance for every job execution.
- Use free minutes on your {% data variables.product.prodname_dotcom %} plan, with per-minute rates applied after surpassing the free minutes.
**Self-hosted runners:**
**Self-hosted runners:**{% endif %}
- Receive automatic updates for the self-hosted runner application only. You are responsible for updating the operating system and all other software.
- Can use cloud services or local machines that you already pay for.
- Are customizable to your hardware, operating system, software, and security requirements.
@@ -217,14 +218,20 @@ codeload.github.com
{% endif %}
{% ifversion fpt or ghec %}
## Self-hosted runner security
## Self-hosted runner security with public repositories
{% ifversion fpt or ghec %}
{% data reusables.github-actions.self-hosted-runner-security %}
{% endif %}
{% ifversion fpt or ghec %}
This is not an issue with {% data variables.product.prodname_dotcom %}-hosted runners because each {% data variables.product.prodname_dotcom %}-hosted runner is always a clean isolated virtual machine, and it is destroyed at the end of the job execution.
{% endif %}
Untrusted workflows running on your self-hosted runner pose significant security risks for your machine and network environment, especially if your machine persists its environment between jobs. Some of the risks include:
* Malicious programs running on the machine.
@@ -232,4 +239,4 @@ Untrusted workflows running on your self-hosted runner pose significant security
* Exposing access to the machine's network environment.
* Persisting unwanted or dangerous data on the machine.
{% endif %}
For more information about security hardening for self-hosted runners, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)."

1
content/actions/hosting-your-own-runners/adding-self-hosted-runners.md
View File

@@ -16,7 +16,6 @@ shortTitle: Add self-hosted runners
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
You can add a self-hosted runner to a repository, an organization, or an enterprise.

1
content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md
View File

@@ -11,7 +11,6 @@ type: overview
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About autoscaling

1
content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md
View File

@@ -16,7 +16,6 @@ shortTitle: Run runner app on startup
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
{% capture service_first_step %}1. Stop the self-hosted runner application if it is currently running.{% endcapture %}
{% capture service_non_windows_intro_shell %}On the runner machine, open a shell in the directory where you installed the self-hosted runner application. Use the commands below to install and manage the self-hosted runner service.{% endcapture %}

7
content/actions/hosting-your-own-runners/index.md
View File

@@ -4,6 +4,12 @@ intro: You can create self-hosted runners to run workflows in a highly customiza
redirect_from:
- /github/automating-your-workflow-with-github-actions/hosting-your-own-runners
- /actions/automating-your-workflow-with-github-actions/hosting-your-own-runners
- /actions/using-github-hosted-runners/about-ae-hosted-runners
- /actions/using-github-hosted-runners/adding-ae-hosted-runners
- /actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow
- /actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners
- /actions/using-github-hosted-runners/using-groups-to-manage-access-to-ae-hosted-runners
- /actions/using-github-hosted-runners/creating-custom-images
versions:
fpt: '*'
ghes: '*'
@@ -24,4 +30,3 @@ children:
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}

5
content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md
View File

@@ -15,7 +15,6 @@ shortTitle: Manage runner groups
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About self-hosted runner groups
@@ -181,7 +180,7 @@ Could not find any self-hosted runner group named "rg-runnergroup".
## Moving a self-hosted runner to a group
If you don't specify a runner group during the registration process, your new self-hosted runners are automatically assigned to the default group, and can then be moved to another group.
{% ifversion ghec or ghes > 3.1 or ghae-next %}
{% ifversion ghec or ghes > 3.1 or ghae %}
{% data reusables.github-actions.self-hosted-runner-navigate-to-org-enterprise %}
1. In the "Runners" list, click the runner that you want to configure.
2. Select the Runner group dropdown menu.
@@ -199,7 +198,7 @@ If you don't specify a runner group during the registration process, your new se
Self-hosted runners are automatically returned to the default group when their group is removed.
{% ifversion ghes > 3.1 or ghae-next or ghec %}
{% ifversion ghes > 3.1 or ghae or ghec %}
{% data reusables.github-actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %}
1. In the list of groups, to the right of the group you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
2. To remove the group, click **Remove group**.

3
content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md
View File

@@ -18,7 +18,6 @@ shortTitle: Monitor & troubleshoot
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Checking the status of a self-hosted runner
@@ -26,7 +25,7 @@ shortTitle: Monitor & troubleshoot
{% data reusables.github-actions.self-hosted-runner-navigate-repo-and-org %}
{% data reusables.github-actions.settings-sidebar-actions-runners %}
1. Under {% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}"Runners"{% else %}"Self-hosted runners"{% endif %}, you can view a list of registered runners, including the runner's name, labels, and status.
1. Under {% ifversion fpt or ghes > 3.1 or ghae or ghec %}"Runners"{% else %}"Self-hosted runners"{% endif %}, you can view a list of registered runners, including the runner's name, labels, and status.
The status can be one of the following:

3
content/actions/hosting-your-own-runners/removing-self-hosted-runners.md
View File

@@ -16,7 +16,6 @@ shortTitle: Remove self-hosted runners
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Removing a runner from a repository
@@ -58,7 +57,7 @@ To remove a self-hosted runner from a user repository you must be the repository
To remove a self-hosted runner from an organization, you must be an organization owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)."
{% data reusables.github-actions.self-hosted-runner-reusing %}
{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
{% data reusables.organizations.navigate-to-org %}
{% data reusables.organizations.org_settings %}
{% data reusables.github-actions.settings-sidebar-actions %}

1
content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md
View File

@@ -15,7 +15,6 @@ shortTitle: Proxy servers
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Configuring a proxy server using environment variables

1
content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md
View File

@@ -13,7 +13,6 @@ shortTitle: Label runners
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
For information on how to use labels to route jobs to specific types of self-hosted runners, see "[Using self-hosted runners in a workflow](/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow)."

3
content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md
View File

@@ -16,7 +16,6 @@ shortTitle: Use runners in a workflow
{% data reusables.actions.ae-self-hosted-runners-notice %}
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
For information on creating custom and default labels, see "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)."
@@ -71,7 +70,7 @@ These labels operate cumulatively, so a self-hosted runner’s labels must match
When routing a job to a self-hosted runner, {% data variables.product.prodname_dotcom %} looks for a runner that matches the job's `runs-on` labels:
{% ifversion fpt or ghes > 3.2 or ghae-next or ghec %}
{% ifversion fpt or ghes > 3.2 or ghae or ghec %}
- {% data variables.product.prodname_dotcom %} first searches for an online and idle runner at the repository level, then at the organization level, {% ifversion fpt or ghec %} and if the organization is part of an enterprise,{% endif %} then at the enterprise level.
- If {% data variables.product.prodname_dotcom %} finds an online and idle runner at a certain level that matches the job's `runs-on` labels, the job is then assigned and sent to the runner.
- If the runner doesn't pick up the assigned job within 60 seconds, the job is queued at all levels and waits for a matching runner from any level to come online and pick up the job.

3
content/actions/learn-github-actions/contexts.md
View File

@@ -18,7 +18,6 @@ miniTocMaxHeadingLevel: 3
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About contexts
@@ -142,7 +141,7 @@ The `runner` context contains information about the runner that is executing the
| `runner.os` | `string` | {% data reusables.actions.runner-os-description %} |{% if actions-runner-arch-envvars %}
| `runner.arch` | `string` | {% data reusables.actions.runner-arch-description %} |{% endif %}
| `runner.temp` | `string` | {% data reusables.actions.runner-temp-directory-description %} |
| `runner.tool_cache` | `string` | {% 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 %} {% data reusables.actions.runner-tool-cache-description %} {% endif %}|
| `runner.tool_cache` | `string` | {% ifversion ghae %}{% data reusables.actions.self-hosted-runners-software %} {% else %} {% data reusables.actions.runner-tool-cache-description %} {% endif %}|
### `needs` context

1
content/actions/learn-github-actions/creating-workflow-templates.md
View File

@@ -17,7 +17,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Overview

1
content/actions/learn-github-actions/environment-variables.md
View File

@@ -15,7 +15,6 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About environment variables

1
content/actions/learn-github-actions/essential-features-of-github-actions.md
View File

@@ -14,7 +14,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Overview

1
content/actions/learn-github-actions/events-that-trigger-workflows.md
View File

@@ -17,7 +17,6 @@ shortTitle: Events that trigger workflows
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Configuring workflow events

1
content/actions/learn-github-actions/expressions.md
View File

@@ -12,7 +12,6 @@ miniTocMaxHeadingLevel: 3
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About expressions

1
content/actions/learn-github-actions/finding-and-customizing-actions.md
View File

@@ -19,7 +19,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Overview

1
content/actions/learn-github-actions/index.md
View File

@@ -46,4 +46,3 @@ children:
- /usage-limits-billing-and-administration
---
{% data reusables.actions.ae-beta %}

16
content/actions/learn-github-actions/managing-complex-workflows.md
View File

@@ -14,7 +14,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Overview
@@ -146,17 +145,6 @@ For more information, see "[Using databases and service containers](/actions/con
This feature helps you assign jobs to a specific hosted runner. If you want to be sure that a particular type of runner will process your job, you can use labels to control where jobs are executed. You can assign labels to a self-hosted runner in addition to their default label of `self-hosted`. Then, you can refer to these labels in your YAML workflow, ensuring that the job is routed in a predictable way.{% ifversion not ghae %} {% data variables.product.prodname_dotcom %}-hosted runners have predefined labels assigned.{% endif %}
{% ifversion ghae %}
This example shows how a workflow can use labels to specify the required runner:
```yaml
jobs:
example-job:
runs-on: [AE-runner-for-CI]
```
For more information, see ["Using labels with {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners)."
{% else %}
This example shows how a workflow can use labels to specify the required runner:
```yaml
@@ -168,12 +156,14 @@ jobs:
A workflow will only run on a runner that has all the labels in the `runs-on` array. The job will preferentially go to an idle self-hosted runner with the specified labels. If none are available and a {% data variables.product.prodname_dotcom %}-hosted runner with the specified labels exists, the job will go to a {% data variables.product.prodname_dotcom %}-hosted runner.
To learn more about self-hosted runner labels, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)."
{% ifversion fpt or ghes %}
To learn more about {% data variables.product.prodname_dotcom %}-hosted runner labels, see ["Supported runners and hardware resources"](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources).
{% endif %}
{% data reusables.actions.reusable-workflows %}
{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
## Using environments

10
content/actions/learn-github-actions/reusing-workflows.md
View File

@@ -15,7 +15,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Overview
@@ -49,17 +48,16 @@ A reusable workflow can be used by another workflow if {% ifversion ghes or ghec
## Using runners
{% ifversion fpt or ghes or ghec %}
### Using GitHub-hosted runners
{% ifversion fpt or ghes or ghec %}
The assignment of {% data variables.product.prodname_dotcom %}-hosted runners is always evaluated using only the caller's context. Billing for {% data variables.product.prodname_dotcom %}-hosted runners is always associated with the caller. The caller workflow cannot use {% data variables.product.prodname_dotcom %}-hosted runners from the called repository. For more information, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)."
{% endif %}
{% ifversion ghae %}
The assignment of {% data variables.actions.hosted_runner %}s is always evaluated using only the caller's context. Billing for {% data variables.actions.hosted_runner %}s is always associated with the caller. The caller cannot use {% data variables.actions.hosted_runner %}s from the called repository. For more information, see "[About {% data variables.actions.hosted_runner %}s](/github-ae@latest/actions/using-github-hosted-runners/about-ae-hosted-runners)."
{% endif %}
### Using self-hosted runners
{% endif %}
Called workflows can access self-hosted runners from caller's context. This means that a called workflow can access self-hosted runners that are:
* In the caller repository
* In the caller repository's organization{% ifversion ghes or ghec or ghae %} or enterprise{% endif %}, provided that the runner has been made available to the caller repository

1
content/actions/learn-github-actions/sharing-workflows-secrets-and-runners-with-your-organization.md
View File

@@ -14,7 +14,6 @@ type: how_to
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Overview

11
content/actions/learn-github-actions/understanding-github-actions.md
View File

@@ -19,7 +19,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Overview
@@ -63,11 +62,7 @@ You can write your own actions, or you can find actions to use in your workflows
### Runners
{% ifversion ghae %}
{% data reusables.actions.about-runners %} For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s that are bundled with your instance in the cloud. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)."
{% else %}
{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% data variables.product.prodname_dotcom %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)."
{% endif %}
{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% ifversion ghes or ghae %} You must host your own runners for {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[Hosting your own runners](/actions/hosting-your-own-runners)."
## Create an example workflow
@@ -250,8 +245,12 @@ Once your workflow has started running, you can {% ifversion fpt or ghes > 3.0 o
To continue learning about {% data variables.product.prodname_actions %}, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)."
{% ifversion fpt or ghec or ghes %}
To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)".
{% endif %}
## Contacting support
{% data reusables.github-actions.contacting-support %}

6
content/actions/learn-github-actions/usage-limits-billing-and-administration.md
View File

@@ -7,7 +7,6 @@ redirect_from:
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Billing
@@ -16,7 +15,6 @@ shortTitle: Workflow billing & limits
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About billing for {% data variables.product.prodname_actions %}
@@ -65,10 +63,10 @@ Usage limits apply to self-hosted runners. For more information, see "[About sel
In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service/). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/free-pro-team@latest/github/site-policy/github-additional-product-terms#a-actions-usage).
{% endif %}
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
{% ifversion fpt or ghes > 3.3 or ghec %}
## Billing for reusable workflows
If you reuse a workflow, billing is always associated with the caller workflow. Assignment of {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dotcom %}-hosted runners{% endif %}{% ifversion ghae %}{% data variables.actions.hosted_runner %}s{% endif %} is always evaluated using only the caller's context. The caller cannot use {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dotcom %}-hosted runners{% endif %}{% ifversion ghae %}{% data variables.actions.hosted_runner %}s{% endif %} from the called repository.
If you reuse a workflow, billing is always associated with the caller workflow. Assignment of {% data variables.product.prodname_dotcom %}-hosted runners is always evaluated using only the caller's context. The caller cannot use {% data variables.product.prodname_dotcom %}-hosted runners from the called repository.
For more information see, "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."
{% endif %}

1
content/actions/learn-github-actions/using-workflow-templates.md
View File

@@ -22,7 +22,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About workflow templates

1
content/actions/learn-github-actions/workflow-commands-for-github-actions.md
View File

@@ -18,7 +18,6 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About workflow commands

42
content/actions/learn-github-actions/workflow-syntax-for-github-actions.md
View File

@@ -16,7 +16,6 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About YAML syntax for workflows
@@ -326,7 +325,7 @@ The triggered workflow receives the inputs in the `github.event.inputs` context.
For more information about cron syntax, see "[Events that trigger workflows](/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#scheduled-events)."
{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
## `permissions`
You can modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)."
@@ -386,7 +385,7 @@ defaults:
working-directory: scripts
```
{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}
{% ifversion fpt or ghae or ghes > 3.1 or ghec %}
## `concurrency`
Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use the [`github` context](/actions/learn-github-actions/contexts#github-context). For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)."
@@ -402,7 +401,7 @@ A workflow run is made up of one or more jobs. Jobs run in parallel by default.
Each job runs in a runner environment specified by `runs-on`.
You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see "[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" for self-hosted runner usage limits.
You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see {% ifversion fpt or ghec or ghes %}"[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and {% endif %}"[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits){% ifversion fpt or ghec or ghes %}" for self-hosted runner usage limits.{% elsif ghae %}."{% endif %}
If you need to find the unique identifier of a job running in a workflow run, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. For more information, see "[Workflow Jobs](/rest/reference/actions#workflow-jobs)."
@@ -465,22 +464,9 @@ In this example, `job3` uses the `always()` conditional expression so that it al
## `jobs.<job_id>.runs-on`
**Required**. The type of machine to run the job on. The machine can be either a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner. You can provide `runs-on` as a single string or as an array of strings.
**Required**. The type of machine to run the job on. {% ifversion fpt or ghec %}The machine can be either a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner.{% endif %} You can provide `runs-on` as a single string or as an array of strings.
{% ifversion ghae %}
### {% data variables.actions.hosted_runner %}s
If you use an {% data variables.actions.hosted_runner %}, each job runs in a fresh instance of a virtual environment specified by `runs-on`.
#### Example
```yaml
runs-on: [AE-runner-for-CI]
```
For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)."
{% else %}
{% ifversion fpt or ghec or ghes %}
{% data reusables.actions.enterprise-github-hosted-runners %}
### {% data variables.product.prodname_dotcom %}-hosted runners
@@ -500,7 +486,9 @@ runs-on: ubuntu-latest
For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)."
{% endif %}
{% ifversion fpt or ghec or ghes %}
### Self-hosted runners
{% endif %}
{% data reusables.actions.ae-self-hosted-runners-notice %}
@@ -514,7 +502,7 @@ runs-on: [self-hosted, linux]
For more information, see "[About self-hosted runners](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)."
{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
## `jobs.<job_id>.permissions`
You can modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)."
@@ -576,7 +564,7 @@ environment:
{% endraw %}
{% endif %}
{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}
{% ifversion fpt or ghae or ghes > 3.1 or ghec %}
## `jobs.<job_id>.concurrency`
{% note %}
@@ -675,7 +663,7 @@ You can use the `if` conditional to prevent a job from running unless a conditio
A job contains a sequence of tasks called `steps`. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. {% data variables.product.prodname_dotcom %} provides built-in steps to set up and complete a job.
You can run an unlimited number of steps as long as you are within the workflow usage limits. For more information, see "[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" for self-hosted runner usage limits.
You can run an unlimited number of steps as long as you are within the workflow usage limits. For more information, see {% ifversion fpt or ghec or ghes %}"[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and {% endif %}"[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits){% ifversion fpt or ghec or ghes %}" for self-hosted runner usage limits.{% elsif ghae %}."{% endif %}
### Example
@@ -989,8 +977,9 @@ 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 %}
{% ifversion ghae %}
{% data reusables.actions.self-hosted-runners-software %}
{% elsif fpt or ghec %}
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)."
{% endif %}
@@ -1104,7 +1093,7 @@ The maximum number of minutes to run the step before killing the process.
The maximum number of minutes to let a job run before {% data variables.product.prodname_dotcom %} automatically cancels it. Default: 360
If the timeout exceeds the job execution time limit for the runner, the job will be canceled when the execution time limit is met instead. For more information about job execution time limits, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#usage-limits)."
If the timeout exceeds the job execution time limit for the runner, the job will be canceled when the execution time limit is met instead. For more information about job execution time limits, see {% ifversion fpt or ghec or ghes %}"[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration#usage-limits)" for {% data variables.product.prodname_dotcom %}-hosted runners and {% endif %}"[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits){% ifversion fpt or ghec or ghes %}" for self-hosted runner usage limits.{% elsif ghae %}."{% endif %}
## `jobs.<job_id>.strategy`
@@ -1165,7 +1154,8 @@ steps:
```
{% endraw %}
{% ifversion ghae %}To find supported configuration options for {% data variables.actions.hosted_runner %}s, see "[Software specifications](/actions/using-github-hosted-runners/about-ae-hosted-runners#software-specifications)."
{% ifversion ghae %}
For more information about the configuration of self-hosted runners, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)."
{% else %}To find supported configuration options for {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)."
{% endif %}

3
content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md
View File

@@ -16,7 +16,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -41,7 +40,7 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l
- opened
jobs:
label_issues:
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
permissions:
issues: write{% endif %}
steps:

3
content/actions/managing-issues-and-pull-requests/closing-inactive-issues.md
View File

@@ -16,7 +16,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -38,7 +37,7 @@ In the tutorial, you will first make a workflow file that uses the [`actions/sta
jobs:
close-issues:
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
permissions:
issues: write
pull-requests: write{% endif %}

3
content/actions/managing-issues-and-pull-requests/commenting-on-an-issue-when-a-label-is-added.md
View File

@@ -17,7 +17,6 @@ shortTitle: Add label to comment on issue
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -42,7 +41,7 @@ In the tutorial, you will first make a workflow file that uses the [`peter-evans
jobs:
add-comment:
if: github.event.label.name == 'help-wanted'
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
permissions:
issues: write{% endif %}
steps:

1
content/actions/managing-issues-and-pull-requests/index.md
View File

@@ -17,4 +17,3 @@ children:
- /scheduling-issue-creation
---
{% data reusables.actions.ae-beta %}

1
content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md
View File

@@ -17,7 +17,6 @@ shortTitle: Move assigned issues
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

3
content/actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column.md
View File

@@ -17,7 +17,6 @@ shortTitle: Remove label when adding card
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -43,7 +42,7 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l
jobs:
remove_labels:
if: github.event.project_card.column_id == '12345678'
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
permissions:
issues: write
pull-requests: write{% endif %}

3
content/actions/managing-issues-and-pull-requests/scheduling-issue-creation.md
View File

@@ -16,7 +16,6 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -41,7 +40,7 @@ In the tutorial, you will first make a workflow file that uses the [`imjohnbo/is
jobs:
create_issue:
name: Create team sync issue
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
permissions:
issues: write{% endif %}
steps:

1
content/actions/managing-issues-and-pull-requests/using-github-actions-for-project-management.md
View File

@@ -14,7 +14,6 @@ topics:
shortTitle: Actions for project management
---
{% data reusables.actions.ae-beta %}
You can use {% data variables.product.prodname_actions %} to automate your project management tasks by creating workflows. Each workflow contains a series of tasks that are performed automatically every time the workflow runs. For example, you can create a workflow that runs every time an issue is created to add a label, leave a comment, and move the issue onto a project board.

1
content/actions/managing-workflow-runs/canceling-a-workflow.md
View File

@@ -10,7 +10,6 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
{% data reusables.repositories.permissions-statement-write %}

1
content/actions/managing-workflow-runs/deleting-a-workflow-run.md
View File

@@ -10,7 +10,6 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
{% data reusables.repositories.permissions-statement-write %}

1
content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md
View File

@@ -11,7 +11,6 @@ shortTitle: Disable & enable a workflow
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
Disabling a workflow allows you to stop a workflow from being triggered without having to delete the file from the repo. You can easily re-enable the workflow again on {% data variables.product.prodname_dotcom %}.

1
content/actions/managing-workflow-runs/downloading-workflow-artifacts.md
View File

@@ -11,7 +11,6 @@ shortTitle: Download workflow artifacts
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
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)."

1
content/actions/managing-workflow-runs/index.md
View File

@@ -27,4 +27,3 @@ children:
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}

1
content/actions/managing-workflow-runs/manually-running-a-workflow.md
View File

@@ -11,7 +11,6 @@ shortTitle: Manually run a workflow
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Configuring a workflow to run manually

1
content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md
View File

@@ -14,7 +14,6 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Re-running all the jobs in a workflow

3
content/actions/managing-workflow-runs/removing-workflow-artifacts.md
View File

@@ -11,7 +11,6 @@ shortTitle: Remove workflow artifacts
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Deleting an artifact
@@ -38,7 +37,7 @@ shortTitle: Remove workflow artifacts
## 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)."
Retention periods for artifacts and logs can be configured at the repository, organization, and enterprise level. For more information, see {% ifversion fpt or ghec or ghes %}"[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)."{% elsif ghae %}"[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)," or "[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 %}
You can also define a custom retention period for individual artifacts using the `actions/upload-artifact` action in a workflow. For more information, see "[Storing workflow data as artifacts](/actions/guides/storing-workflow-data-as-artifacts#configuring-a-custom-artifact-retention-period)."

3
content/actions/managing-workflow-runs/reviewing-deployments.md
View File

@@ -9,13 +9,12 @@ versions:
ghec: '*'
---
{% data reusables.actions.ae-beta %}
## About required reviews in workflows
Jobs that reference an environment configured with required reviewers will wait for an approval before starting. While a job is awaiting approval, it has a status of "Waiting". If a job is not approved within 30 days, the workflow run will be automatically canceled.
For more information about environments and required approvals, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} For information about how to review deployments with the REST API, see "[Workflow Runs](/rest/reference/actions#workflow-runs)."{% endif %}
For more information about environments and required approvals, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."{% ifversion fpt or ghae or ghes > 3.1 or ghec %} For information about how to review deployments with the REST API, see "[Workflow Runs](/rest/reference/actions#workflow-runs)."{% endif %}
## Approving or rejecting a job

3
content/actions/managing-workflow-runs/skipping-workflow-runs.md
View File

@@ -4,14 +4,13 @@ intro: You can skip workflow runs triggered by the `push` and `pull_request` eve
versions:
fpt: '*'
ghes: '*'
ghae: next
ghae: '*'
ghec: '*'
shortTitle: Skip workflow runs
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
Workflows that would otherwise be triggered using `on: push` or `on: pull_request` won't be triggered if you add any of the following strings to the commit message in a push, or the HEAD commit of a pull request:

1
content/actions/migrating-to-github-actions/index.md
View File

@@ -18,4 +18,3 @@ children:
- /migrating-from-travis-ci-to-github-actions
---
{% data reusables.actions.ae-beta %}

Some files were not shown because too many files have changed in this diff Show More