jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-03 06:04:16 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into patch-2

Browse Source
This commit is contained in:
Laura Coursen
2021-10-15 16:08:39 -05:00
committed by GitHub
parent ada941dd11 bcecfcf968
commit 38d2fa0070
3054 changed files with 2169 additions and 96474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -5,7 +5,7 @@ See our [CONTRIBUTING.md](/main/CONTRIBUTING.md) for information how to contribu
For changes to content in [site policy](https://github.com/github/docs/tree/main/content/github/site-policy), see the [CONTRIBUTING guide in the site-policy repo](https://github.com/github/site-policy/blob/main/CONTRIBUTING.md).
We cannot accept changes to our translated content right now. See the [contributing.md](/main/CONTRIBUTING.md#earth_asia-translations) for more information.
We cannot accept changes to our translated content right now. See the [types-of-contributions.md](/main/contributing/types-of-contributions.md#earth_asia-translations) for more information.
Thanks again!
-->

2
.github/actions-scripts/create-enterprise-issue.js vendored
View File

@@ -86,7 +86,7 @@ async function run() {
'utf8'
)
const issueLabels =
milestone === 'release' ? ['enterprise release'] : ['enterprise deprecation', 'priority-3']
milestone === 'release' ? ['enterprise release'] : ['enterprise deprecation', 'priority-4', 'batch', 'time sensitive']
const issueTitle = `[${nextMilestoneDate}] Enterprise Server ${versionNumber} ${milestone} (technical steps)`
const issueBody = `GHES ${versionNumber} ${milestone} occurs on ${nextMilestoneDate}.

2
.github/dependabot.yml vendored
View File

@@ -9,4 +9,4 @@ updates:
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: weekly
interval: monthly

2
.github/workflows/crowdin.yml vendored
View File

@@ -27,6 +27,8 @@ jobs:
- name: Sync
uses: crowdin/github-action@d7f217268068f1244883a993379d62d816f84f25
with:
# This option enables the transfer of existing translations in this project to Crowdin.
# We explicitly set this to `false` since we only want to use the downloaded translations managed by Crowdin.
upload_translations: false
download_translations: true
create_pull_request: true

2
.github/workflows/move-reopened-issues-to-triage.yaml vendored
View File

@@ -37,5 +37,5 @@ jobs:
}
}
} catch(e) {
console.log(error);
console.log(e);
}

64
.github/workflows/notify-when-maintainers-cannot-edit.yaml vendored Normal file
View File

@@ -0,0 +1,64 @@
name: Notify When Maintainers Cannot Edit
# **What it does**: Notifies the author of a PR when their PR does not allow maintainers to edit it.
# **Why we have it**: To prevent having to do this manually.
# **Who does it impact**: Open-source.
on:
pull_request_target:
types:
- opened
permissions:
pull-requests: write
jobs:
notify-when-maintainers-cannot-edit:
if: github.repository == 'github/docs'
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
with:
script: |
const query = `
query($number: Int!) {
repository(owner: "github", name: "docs") {
pullRequest(number: $number) {
headRepositoryOwner {
login
}
maintainerCanModify
}
}
}
`;
const pullNumber = context.issue.number;
const variables = { number: pullNumber };
try {
console.log(`Check github/docs#${pullNumber} for maintainer edit access ...`);
const result = await github.graphql(query, variables);
console.log(JSON.stringify(result, null, 2));
const pullRequest = result.repository.pullRequest;
if (pullRequest.headRepositoryOwner.login === 'github') {
console.log('PR owned by github');
return;
}
if (!pullRequest.maintainerCanModify) {
console.log('PR not owned by github and does not have maintainer edits enabled');
await github.issues.createComment({
issue_number: pullNumber,
owner: 'github',
repo: 'docs',
body: "Thanks for submitting a PR to the GitHub Docs project!\n\nIn order to review and merge PRs most efficiently, we require that all PRs grant maintainer edit access before we review them. For information on how to do this, [see the documentation](https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)."
});
}
} catch(e) {
console.log(e);
}

11
.github/workflows/staging-deploy-pr.yml vendored
View File

@@ -79,9 +79,18 @@ jobs:
name: prRepoName
}
} = run
const headLabel = `${prRepoOwner}:${headBranch}`
const prIsInternal = owner === prRepoOwner && repo === prRepoName
let headLabel = `${prRepoOwner}:${headBranch}`
// If the PR is external, prefix its head branch name with the
// forked repo owner's login and their fork repo name e.g.
// "octocat/my-fork:docs". We need to include the fork repo
// name as well to account for an API issue (this will work fine
// if they don't have a different fork repo name).
if (!prIsInternal) {
headLabel = `${prRepoOwner}/${prRepoName}:${headBranch}`
}
// If the PR is external, prefix its head branch name with the
// forked repo owner's login, e.g. "octocat:docs"

1
.github/workflows/triage-issues.yml vendored
View File

@@ -12,6 +12,7 @@ on:
permissions:
issues: write
repository-projects: write
jobs:
triage_issues:

2
CONTRIBUTING.md
View File

@@ -6,7 +6,7 @@ Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approacha
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of the this document to get to a specific section of this guide quickly.
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
## New contributor guide

4
README.md
View File

@@ -4,7 +4,7 @@ This repository contains the documentation website code and Markdown source file
GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of the this document to get to a specific section of this guide quickly.
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
## Contributing
@@ -60,4 +60,4 @@ When using the GitHub logos, be sure to follow the [GitHub logo guidelines](http
## Thanks :purple_heart:
Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our ✨ community ✨ !
Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: !

BIN
assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 160 KiB

BIN
assets/images/help/pull_requests/compare-branch-example.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 38 KiB

BIN
assets/images/help/repository/code-scanning-library-alert-index.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
assets/images/help/repository/code-scanning-library-alert-show.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 24 KiB

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

@@ -134,8 +134,8 @@ Email notifications from {% data variables.product.product_name %} contain the f
| --- | --- |
| `From` address | This address will always be {% ifversion fpt %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. |
| `To` field | This field connects directly to the thread.{% ifversion not ghae %} If you reply to the email, you'll add a new comment to the conversation.{% endif %} |
| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: <ul><li>`assign`: You were assigned to an issue or pull request.</li><li>`author`: You created an issue or pull request.</li><li>`ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.</li><li>`comment`: You commented on an issue or pull request.</li><li>`manual`: There was an update to an issue or pull request you manually subscribed to.</li><li>`mention`: You were mentioned on an issue or pull request.</li><li>`push`: Someone committed to a pull request you're subscribed to.</li><li>`review_requested`: You or a team you're a member of was requested to review a pull request.</li>{% ifversion not ghae %}<li>`security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.</li>{% endif %}<li>`state_change`: An issue or pull request you're subscribed to was either closed or opened.</li><li>`subscribed`: There was an update in a repository you're watching.</li><li>`team_mention`: A team you belong to was mentioned on an issue or pull request.</li><li>`your_activity`: You opened, commented on, or closed an issue or pull request.</li></ul> |
| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `<repository name>.<repository owner>.{% data variables.command_line.backticks %}`. |{% ifversion fpt or ghes %}
| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: <ul><li>`assign`: You were assigned to an issue or pull request.</li><li>`author`: You created an issue or pull request.</li><li>`ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.</li><li>`comment`: You commented on an issue or pull request.</li><li>`manual`: There was an update to an issue or pull request you manually subscribed to.</li><li>`mention`: You were mentioned on an issue or pull request.</li><li>`push`: Someone committed to a pull request you're subscribed to.</li><li>`review_requested`: You or a team you're a member of was requested to review a pull request.</li>{% ifversion fpt or ghes or ghae-issue-4864 %}<li>`security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.</li>{% endif %}<li>`state_change`: An issue or pull request you're subscribed to was either closed or opened.</li><li>`subscribed`: There was an update in a repository you're watching.</li><li>`team_mention`: A team you belong to was mentioned on an issue or pull request.</li><li>`your_activity`: You opened, commented on, or closed an issue or pull request.</li></ul> |
| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `<repository name>.<repository owner>.{% data variables.command_line.backticks %}`. |{% ifversion fpt or ghes or ghae-issue-4864 %}
| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:<ul><li>`low`</li><li>`moderate`</li><li>`high`</li><li>`critical`</li></ul>For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." |{% endif %}
## Choosing your notification settings
@@ -144,7 +144,7 @@ Email notifications from {% data variables.product.product_name %} contain the f
{% data reusables.notifications-v2.manage-notifications %}
3. On the notifications settings page, choose how you receive notifications when:
- There are updates in repositories or team discussions you're watching or in a conversation you're participating in. For more information, see "[About participating and watching notifications](#about-participating-and-watching-notifications)."
- You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."{% ifversion fpt or ghes %}
- You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."{% ifversion fpt or ghes or ghae-issue-4864 %}
- There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% endif %} {% ifversion fpt %}
- There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %}
@@ -161,14 +161,14 @@ If "Automatically watch repositories" is disabled, then you will not automatical
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 %}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, click the "Watch" drop-down menu to select a watch option.
{% ifversion fpt or ghes > 3.0 or ghae-next %}
2. In the upper-right corner, select the "Watch" drop-down menu to click a watch option.
{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 %}
![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom.png)
The **Custom** option allows you to further customize notifications so that you're only notified when specific events happen in the repository, in addition to participating and @mentions.
{% else %}
![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options.png){% endif %}
{% ifversion fpt or ghes > 3.0 or ghae-next %}
{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 %}
![Custom watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom2-dotcom.png)
If you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues.
{% endif %}
@@ -198,12 +198,8 @@ If you are a member of more than one organization, you can configure each one to
5. Select one of your verified email addresses, then click **Save**.
![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif)
{% ifversion not ghae %}
{% ifversion fpt or ghes %}
{% ifversion fpt or ghes or ghae-issue-4864 %}
## {% data variables.product.prodname_dependabot_alerts %} notification options
{% else %}
## Security alert notification options
{% endif %}
{% data reusables.notifications.vulnerable-dependency-notification-enable %}
{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %}

19
content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md
View File

@@ -114,14 +114,14 @@ To filter notifications for specific activity on {% data variables.product.produ
- `is:gist`
- `is:issue-or-pull-request`
- `is:release`
- `is:repository-invitation`{% ifversion not ghae %}
- `is:repository-vulnerability-alert`
- `is:repository-invitation`{% ifversion fpt or ghes or ghae-issue-4864 %}
- `is:repository-vulnerability-alert`{% endif %}{% ifversion fpt %}
- `is:repository-advisory`{% endif %}
- `is:team-discussion`{% ifversion fpt %}
- `is:discussion`{% endif %}
{% ifversion not ghae %}
For information about reducing noise from notifications for {% ifversion fpt or ghes %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
{% ifversion fpt or ghes or ghae-issue-4864 %}
For information about reducing noise from notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
{% endif %}
You can also use the `is:` query to describe how the notification was triaged.
@@ -144,7 +144,7 @@ To filter notifications by why you've received an update, you can use the `reaso
| `reason:invitation` | When you're invited to a team, organization, or repository.
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
| `reason:mention` | You were directly @mentioned.
| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% ifversion not ghae %}
| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% ifversion fpt or ghes or ghae-issue-4864 %}
| `reason:security-alert` | When a security alert is issued for a repository.{% endif %}
| `reason:state-change` | When the state of a pull request or issue is changed. For example, an issue is closed or a pull request is merged.
| `reason:team-mention` | When a team you're a member of is @mentioned.
@@ -163,7 +163,7 @@ For example, to see notifications from the octo-org organization, use `org:octo-
{% endif %}
{% ifversion fpt or ghes %}
{% ifversion fpt or ghes or ghae-issue-4864 %}
## {% data variables.product.prodname_dependabot %} custom filters
{% ifversion fpt %}
@@ -175,8 +175,11 @@ If you use {% data variables.product.prodname_dependabot %} to keep your depende
For more information about {% data variables.product.prodname_dependabot %}, see "[About managing vulnerable dependencies](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)."
{% endif %}
{% ifversion ghes %}
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies-up-to-date, you can use and save the `is:repository_vulnerability_alert` custom filter to show notifications for {% data variables.product.prodname_dependabot_alerts %}.
{% ifversion ghes or ghae-issue-4864 %}
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies-up-to-date, you can use and save these custom filters to show notifications for {% data variables.product.prodname_dependabot_alerts %}:
- `is:repository_vulnerability_alert`
- `reason:security_alert`
For more information about {% data variables.product.prodname_dependabot %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
{% endif %}

2
content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md
View File

@@ -14,7 +14,7 @@ topics:
- Profiles
shortTitle: Organization's profile
---
You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories. You can customize your organization's profile by adding a README.md file. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."
You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories.{% ifversion not ghes and not ghae %} You can customize your organization's profile by adding a README.md file. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %}
{% ifversion fpt %}To confirm your organization's identity and display a "Verified" badge on your organization profile page, you must verify your organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)."{% endif %}

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

@@ -43,8 +43,8 @@ The repository owner has full control of the repository. In addition to the acti
| Delete and restore packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %}{% ifversion ghes = 2.22 or ghes = 3.0 or ghae %}
| Delete packages | "[Deleting packages](/packages/learn-github-packages/deleting-a-package)" |{% endif %}
| Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" |
| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes %}
| Receive {% ifversion fpt or ghes %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} for vulnerable dependencies | "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" |{% endif %}{% ifversion fpt %}
| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes > 2.22 or ghae-issue-4864 %}
| Control access to {% data variables.product.prodname_dependabot_alerts %} alerts for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt %}
| Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" |
| Manage data use for a private repository | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"|{% endif %}
| Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" |

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

@@ -13,3 +13,5 @@ children:
- /storing-workflow-data-as-artifacts
- /using-github-cli-in-workflows
---
{% data reusables.actions.ae-beta %}

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

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

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

@@ -14,6 +14,8 @@ topics:
type: how_to
---
{% data reusables.actions.ae-beta %}
{% data reusables.cli.cli-learn-more %}
{% data variables.product.prodname_cli %} is preinstalled on all {% data variables.product.prodname_dotcom %}-hosted runners. For each step that uses {% data variables.product.prodname_cli %}, you must set an environment variable called `GITHUB_TOKEN` to a token with the required scopes.

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

@@ -20,6 +20,7 @@ shortTitle: Continuous integration
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About continuous integration

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

@@ -19,6 +19,7 @@ shortTitle: Build & test Java & Ant
{% 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/building-and-testing-java-with-gradle.md
View File

@@ -19,6 +19,7 @@ shortTitle: Build & test Java & Gradle
{% 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/building-and-testing-java-with-maven.md
View File

@@ -19,6 +19,7 @@ shortTitle: Build & test Java with Maven
{% 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/building-and-testing-net.md
View File

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

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

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

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

@@ -22,6 +22,7 @@ hasExperimentalAlternative: true
{% 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/building-and-testing-powershell.md
View File

@@ -19,6 +19,7 @@ shortTitle: Build & test PowerShell
{% 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/building-and-testing-python.md
View File

@@ -21,6 +21,7 @@ hasExperimentalAlternative: true
{% 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/building-and-testing-ruby.md
View File

@@ -17,6 +17,7 @@ shortTitle: Build & test Ruby
{% 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/building-and-testing-swift.md
View File

@@ -17,6 +17,7 @@ shortTitle: Build & test Swift
{% 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/building-and-testing-xamarin-applications.md
View File

@@ -21,6 +21,7 @@ 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

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

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

@@ -20,6 +20,7 @@ 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,6 +16,7 @@ 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,6 +20,7 @@ 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,6 +20,7 @@ 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,6 +14,7 @@ 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

@@ -24,3 +24,4 @@ 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,6 +17,7 @@ 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,6 +14,7 @@ type: how_to
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About exit codes

6
content/actions/deployment/about-continuous-deployment.md
View File

@@ -14,6 +14,7 @@ shortTitle: Continuous deployment
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About continuous deployment
@@ -34,9 +35,12 @@ You can configure your CD workflow to run when a {% data variables.product.produ
{% data reusables.actions.cd-templates-actions %}
{% ifversion fpt or ghae or ghes > 3.0 %}
## Further reading
- [Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)
- [Using environments for deployment](/actions/deployment/using-environments-for-deployment){% ifversion fpt %}
- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"
- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"{% endif %}
{% endif %}

12
content/actions/deployment/deploying-to-amazon-elastic-container-service.md
View File

@@ -18,12 +18,13 @@ shortTitle: Deploy to Amazon ECS
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to [Amazon Elastic Container Registry (ECR)](https://aws.amazon.com/ecr/), and deploy it to [Amazon Elastic Container Service (ECS)](https://aws.amazon.com/ecs/) when a release is created.
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to [Amazon Elastic Container Registry (ECR)](https://aws.amazon.com/ecr/), and deploy it to [Amazon Elastic Container Service (ECS)](https://aws.amazon.com/ecs/) when there is a push to the `main` branch.
On every new release in your {% data variables.product.company_short %} repository, the {% data variables.product.prodname_actions %} workflow builds and pushes a new container image to Amazon ECR, and then deploys a new task definition to Amazon ECS.
On every new push to `main` in your {% data variables.product.company_short %} repository, the {% data variables.product.prodname_actions %} workflow builds and pushes a new container image to Amazon ECR, and then deploys a new task definition to Amazon ECS.
## Prerequisites
@@ -67,7 +68,9 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you
See the documentation for each action used below for the recommended IAM policies for the IAM user, and methods for handling the access key credentials.
{% ifversion fpt or ghes > 3.0 or ghae %}
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
{% endif %}
## Creating the workflow
@@ -85,8 +88,9 @@ Ensure that you provide your own values for all the variables in the `env` key o
name: Deploy to Amazon ECS
on:
release:
types: [ created ]
push:
branches:
- main
env:
AWS_REGION: MY_AWS_REGION # set this to your preferred AWS region, e.g. us-west-1

10
content/actions/deployment/deploying-to-azure-app-service.md
View File

@@ -18,6 +18,7 @@ shortTitle: Deploy to Azure App Service
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -69,13 +70,15 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you
4. For Linux apps, add an app setting called `WEBSITE_WEBDEPLOY_USE_SCM` and set it to true in your app. For more information, see "[Configure apps in the portal](https://docs.microsoft.com/en-us/azure/app-service/configure-common#configure-app-settings)" in the Azure documentation.
{% ifversion fpt or ghes > 3.0 or ghae %}
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
{% endif %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when a release is created.
The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when there is a push to the `main` branch.
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. You can also change `AZURE_WEBAPP_PACKAGE_PATH` if the path to your project is not the repository root and `NODE_VERSION` if you want to use a node version other than `10.x`.
@@ -85,8 +88,9 @@ Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of
{% data reusables.actions.actions-not-certified-by-github-comment %}
on:
release:
types: [created]
push:
branches:
- main
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name

10
content/actions/deployment/deploying-to-google-kubernetes-engine.md
View File

@@ -18,10 +18,11 @@ shortTitle: Deploy to Google Kubernetes Engine
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to Google Container Registry (GCR), and deploy it to Google Kubernetes Engine (GKE) when a release is created.
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to Google Container Registry (GCR), and deploy it to Google Kubernetes Engine (GKE) when there is a push to the `main` branch.
GKE is a managed Kubernetes cluster service from Google Cloud that can host your containerized workloads in the cloud or in your own datacenter. For more information, see [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine).
@@ -105,9 +106,11 @@ Store the name of your project as a secret named `GKE_PROJECT`. For more informa
### (Optional) Configuring kustomize
Kustomize is an optional tool used for managing YAML specs. After creating a _kustomization_ file, the workflow below can be used to dynamically set fields of the image and pipe in the result to `kubectl`. For more information, see [kustomize usage](https://github.com/kubernetes-sigs/kustomize#usage).
{% ifversion fpt or ghes > 3.0 or ghae %}
### (Optional) Configure a deployment environment
{% data reusables.actions.about-environments %}
{% endif %}
## Creating the workflow
@@ -125,8 +128,9 @@ Under the `env` key, change the value of `GKE_CLUSTER` to the name of your clust
name: Build and Deploy to GKE
on:
release:
types: [created]
push:
branches:
- main
env:
PROJECT_ID: {% raw %}${{ secrets.GKE_PROJECT }}{% endraw %}

7
content/actions/deployment/deploying-with-github-actions.md
View File

@@ -14,6 +14,7 @@ shortTitle: Deploy with GitHub Actions
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction
@@ -31,13 +32,12 @@ You should be familiar with the syntax for {% data variables.product.prodname_ac
## Triggering your deployment
You can use a variety of events to trigger your deployment workflow. Some of the most common are: `pull_request`, `push`, `release`, and `workflow_dispatch`.
You can use a variety of events to trigger your deployment workflow. Some of the most common are: `pull_request`, `push`, and `workflow_dispatch`.
For example, a workflow with the following triggers runs whenever:
- There is a push to the `main` branch.
- A pull request targeting the `main` branch is opened, synchronized, or reopened.
- A release is created.
- Someone manually triggers it.
```yaml
@@ -48,9 +48,6 @@ on:
pull_request:
branches:
- main
release:
types:
- created
workflow_dispatch:
```

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

@@ -17,3 +17,4 @@ children:
- /installing-an-apple-certificate-on-macos-runners-for-xcode-development
---
{% data reusables.actions.ae-beta %}

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

@@ -17,6 +17,7 @@ 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/using-environments-for-deployment.md
View File

@@ -13,6 +13,7 @@ versions:
ghae: '*'
---
{% data reusables.actions.ae-beta %}
## About environments

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

@@ -12,6 +12,7 @@ redirect_from:
- /developers/overview/viewing-deployment-history
---
{% data reusables.actions.ae-beta %}
You can deliver deployments through {% ifversion fpt or ghae or ghes > 3.0 %}{% data variables.product.prodname_actions %} and environments or with {% endif %}the REST API and third party apps. {% ifversion fpt or ghae ghes > 3.0 %}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)."

66
content/actions/guides.md Normal file
View File

@@ -0,0 +1,66 @@
---
title: Guides for GitHub Actions
intro: 'These guides for {% data variables.product.prodname_actions %} include specific use cases and examples to help you configure workflows.'
allowTitleToDifferFromFilename: true
layout: product-sublanding
versions:
fpt: '*'
ghes: '*'
ghae: '*'
learningTracks:
- getting_started
- continuous_integration
- continuous_deployment
- deploy_to_the_cloud
- hosting_your_own_runners
- create_actions
includeGuides:
- /actions/quickstart
- /actions/learn-github-actions/introduction-to-github-actions
- /actions/creating-actions/creating-a-docker-container-action
- /actions/learn-github-actions/using-workflow-templates
- /actions/automating-builds-and-tests/building-and-testing-python
- /actions/automating-builds-and-tests/building-and-testing-nodejs
- /actions/publishing-packages/about-packaging-with-github-actions
- /actions/publishing-packages/publishing-docker-images
- /actions/advanced-guides/caching-dependencies-to-speed-up-workflows
- /actions/automating-builds-and-tests/about-continuous-integration
- /actions/automating-builds-and-tests/building-and-testing-powershell
- /actions/automating-builds-and-tests/building-and-testing-ruby
- /actions/automating-builds-and-tests/building-and-testing-java-with-maven
- /actions/automating-builds-and-tests/building-and-testing-java-with-gradle
- /actions/automating-builds-and-tests/building-and-testing-java-with-ant
- /actions/automating-builds-and-tests/building-and-testing-swift
- /actions/deployment/installing-an-apple-certificate-on-macos-runners-for-xcode-development
- /actions/automating-builds-and-tests/building-and-testing-xamarin-applications
- /actions/publishing-packages/publishing-nodejs-packages
- /actions/publishing-packages/publishing-java-packages-with-maven
- /actions/publishing-packages/publishing-java-packages-with-gradle
- /actions/advanced-guides/storing-workflow-data-as-artifacts
- /actions/using-containerized-services/about-service-containers
- /actions/using-containerized-services/creating-redis-service-containers
- /actions/using-containerized-services/creating-postgresql-service-containers
- /actions/deployment/deploying-to-amazon-elastic-container-service
- /actions/deployment/deploying-to-azure-app-service
- /actions/deployment/deploying-to-google-kubernetes-engine
- /actions/learn-github-actions/essential-features-of-github-actions
- /actions/security-guides/security-hardening-for-github-actions
- /actions/creating-actions/about-custom-actions
- /actions/creating-actions/creating-a-javascript-action
- /actions/creating-actions/creating-a-composite-action
- /actions/migrating-to-github-actions/migrating-from-azure-pipelines-to-github-actions
- /actions/migrating-to-github-actions/migrating-from-circleci-to-github-actions
- /actions/migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions
- /actions/migrating-to-github-actions/migrating-from-jenkins-to-github-actions
- /actions/migrating-to-github-actions/migrating-from-travis-ci-to-github-actions
- /actions/managing-issues-and-pull-requests/using-github-actions-for-project-management
- /actions/managing-issues-and-pull-requests/closing-inactive-issues
- /actions/managing-issues-and-pull-requests/scheduling-issue-creation
- /actions/managing-issues-and-pull-requests/adding-labels-to-issues
- /actions/managing-issues-and-pull-requests/commenting-on-an-issue-when-a-label-is-added
- /actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards
- /actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot
---

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

@@ -14,6 +14,7 @@ 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

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

@@ -15,6 +15,7 @@ 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.
@@ -34,7 +35,7 @@ For more information, see "[About self-hosted runners](/github/automating-your-w
## Adding a self-hosted runner to a repository
You can add self-hosted runners to a single repository. To add a self-hosted runner to a user repository, you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository.
You can add self-hosted runners to a single repository. To add a self-hosted runner to a user repository, you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. For information about how to add a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)."
{% ifversion fpt %}
{% data reusables.repositories.navigate-to-repo %}
@@ -55,7 +56,7 @@ You can add self-hosted runners to a single repository. To add a self-hosted run
## Adding a self-hosted runner to an organization
You can add self-hosted runners at the organization level, where they can be used to process jobs for multiple repositories in an organization. To add a self-hosted runner to an organization, you must be an organization owner.
You can add self-hosted runners at the organization level, where they can be used to process jobs for multiple repositories in an organization. To add a self-hosted runner to an organization, you must be an organization owner. For information about how to add a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)."
{% ifversion fpt %}
{% data reusables.organizations.navigate-to-org %}
@@ -84,7 +85,7 @@ You can add self-hosted runners to an enterprise, where they can be assigned to
New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see "[Managing access to self-hosted runners](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)."
{% ifversion fpt %}
To add a self-hosted runner to an enterprise account, you must be an enterprise owner.
To add a self-hosted runner to an enterprise account, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions).
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}

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

@@ -10,11 +10,30 @@ 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
You can automatically increase or decrease the number of self-hosted runners in your environment in response to the webhook events you receive with a particular label. For example, you can create automation that adds a new self-hosted runner each time you receive a [`workflow_job`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) webhook event with the [`queued`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) activity, which notifies you that a new job is ready for processing. The webhook payload includes label data, so you can identify the type of runner the job is requesting. Once the job has finished, you can then create automation that removes the runner in response to the `workflow_job` [`completed`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) activity.
## Recommended autoscaling solutions
{% data variables.product.prodname_dotcom %} recommends and partners closely with two open source projects that you can use for autoscaling your runners. One or both solutions may be suitable, based on your needs.
The following repositories have detailed instructions for setting up these autoscalers:
- [actions-runner-controller/actions-runner-controller](https://github.com/actions-runner-controller/actions-runner-controller) - A Kubernetes controller for {% data variables.product.prodname_actions %} self-hosted runnners.
- [philips-labs/terraform-aws-github-runner](https://github.com/philips-labs/terraform-aws-github-runner) - A Terraform module for scalable {% data variables.product.prodname_actions %} runners on Amazon Web Services.
Each solution has certain specifics that may be important to consider:
| **Features** | **actions-runner-controller** | **terraform-aws-github-runner** |
| :--- | :--- | :--- |
| Runtime | Kubernetes | Linux and Windows VMs |
| Supported Clouds | Azure, Amazon Web Services, Google Cloud Platform, on-premises | Amazon Web Services |
| Where runners can be scaled | Enterprise, organization, and repository levels. By runner label and runner group. | Organization and repository levels. By runner label and runner group. |
| Pull-based autoscaling support | Yes | No |
## Using ephemeral runners for autoscaling
{% data variables.product.prodname_dotcom %} recommends implementing autoscaling with ephemeral self-hosted runners; autoscaling with persistent self-hosted runners is not recommended. In certain cases, {% data variables.product.prodname_dotcom %} cannot guarantee that jobs are not assigned to persistent runners while they are shut down. With ephemeral runners, this can be guaranteed because {% data variables.product.prodname_dotcom %} only assigns one job to a runner.
@@ -44,7 +63,7 @@ You can create your own autoscaling environment by using payloads received from
## Authentication requirements
You can register and delete self-hosted runners using [the API](/rest/reference/actions#self-hosted-runners). To authenticate to the API, your autoscaling implementation can use an access token or a {% data variables.product.prodname_dotcom %} app.
You can register and delete repository and organization self-hosted runners using [the API](/rest/reference/actions#self-hosted-runners). To authenticate to the API, your autoscaling implementation can use an access token or a {% data variables.product.prodname_dotcom %} app.
Your access token will require the following scope:
@@ -53,22 +72,8 @@ Your access token will require the following scope:
To authenticate using a {% data variables.product.prodname_dotcom %} App, it must be assigned the following permissions:
- For repositories, assign the `administration` permission.
- for organizations, assign the `organization_self_hosted_runners` permission.
- For organizations, assign the `organization_self_hosted_runners` permission.
## Recommended autoscaling solutions
You can register and delete enterprise self-hosted runners using [the API](/rest/reference/enterprise-admin#github-actions). To authenticate to the API, your autoscaling implementation can use an access token.
{% data variables.product.prodname_dotcom %} recommends and partners closely with two open source projects that you can use for autoscaling your runners. One or both solutions may be suitable, based on your needs.
The following repositories have detailed instructions for setting up these autoscalers:
- [actions-runner-controller/actions-runner-controller](https://github.com/actions-runner-controller/actions-runner-controller) - A Kubernetes controller for {% data variables.product.prodname_actions %} self-hosted runnners.
- [philips-labs/terraform-aws-github-runner](https://github.com/philips-labs/terraform-aws-github-runner) - A Terraform module for scalable {% data variables.product.prodname_actions %} runners on Amazon Web Services.
Each solution has certain specifics that may be important to consider:
| **Features** | **actions-runner-controller** | **terraform-aws-github-runner** |
| :--- | :--- | :--- |
| Runtime | Kubernetes | Linux and Windows VMs |
| Supported Clouds | Azure, Amazon Web Services, Google Cloud Platform, on-premises | Amazon Web Services |
| Where runners can be scaled | Enterprise, organization, and repository levels. By runner label and runner group. | Organization and repository levels. By runner label and runner group. |
| Pull-based autoscaling support | Yes | No |
Your access token will requite the `manage_runners:enterprise` scope.

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

@@ -15,6 +15,7 @@ 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 %}

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

@@ -23,3 +23,4 @@ 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

@@ -14,6 +14,7 @@ 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
@@ -33,7 +34,7 @@ When new runners are created, they are automatically assigned to the default gro
## Creating a self-hosted runner group for an organization
All organizations have a single default self-hosted runner group. Organizations within an enterprise account can create additional self-hosted groups. Organization admins can allow individual repositories access to a runner group.
All organizations have a single default self-hosted runner group. Organizations within an enterprise account can create additional self-hosted groups. Organization admins can allow individual repositories access to a runner group. For information about how to create a self-hosted runner group with the REST API, see "[Self-hosted runner groups](/rest/reference/actions#self-hosted-runner-groups)."
Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can move a runner from the default group to any group you create.
@@ -83,7 +84,7 @@ When creating a group, you must choose a policy that defines which repositories
## Creating a self-hosted runner group for an enterprise
Enterprises can add their self-hosted runners to groups for access management. Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account. Organization admins can then assign additional granular repository access policies to the enterprise runner groups.
Enterprises can add their self-hosted runners to groups for access management. Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account. Organization admins can then assign additional granular repository access policies to the enterprise runner groups. For information about how to create a self-hosted runner group with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions).
Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can assign the runner to a specific group during the registration process, or you can later move the runner from the default group to a custom group.

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

@@ -17,6 +17,7 @@ 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

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

@@ -15,6 +15,7 @@ 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
@@ -26,7 +27,7 @@ shortTitle: Remove self-hosted runners
{% endnote %}
To remove a self-hosted runner from a user repository you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. We recommend that you also have access to the self-hosted runner machine.
To remove a self-hosted runner from a user repository you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. 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 %}
@@ -53,7 +54,7 @@ To remove a self-hosted runner from a user repository you must be the repository
{% endnote %}
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.
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 %}
@@ -81,7 +82,7 @@ To remove a self-hosted runner from an organization, you must be an organization
{% data reusables.github-actions.self-hosted-runner-reusing %}
{% ifversion fpt %}
To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine.
To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions).
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.actions-tab %}

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

@@ -14,6 +14,7 @@ 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

@@ -12,6 +12,7 @@ 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)."

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

@@ -15,6 +15,7 @@ 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)."

1
content/actions/index.md
View File

@@ -59,4 +59,5 @@ children:
- /using-github-hosted-runners
- /hosting-your-own-runners
- /migrating-to-github-actions
- /guides
---

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

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

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

@@ -16,6 +16,7 @@ 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,6 +15,7 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About environment variables

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

@@ -13,6 +13,7 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Overview
@@ -92,6 +93,8 @@ jobs:
name: output-log-file
```
To download an artifact from the same workflow run, your download job should specify `needs: upload-job-name` so it doesn't start until the upload job finishes.
For more information about artifacts, see "[Persisting workflow data using artifacts](/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts)."
## Next steps

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

@@ -17,6 +17,7 @@ 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,6 +12,7 @@ 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

@@ -18,6 +18,7 @@ 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

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

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

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

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

@@ -14,6 +14,7 @@ topics:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
{% note %}
@@ -48,7 +49,6 @@ A reusable workflow can be used by another workflow if any of the following is t
* Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)."
The following limitations will be removed when workflow reuse moves out of beta:
* Reusable workflows can't reference self-hosted runners.
* You can't set the concurrency of a called workflow from the caller workflow. For more information about `jobs.<job_id>.concurrency`, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)."
* Outputs generated by a called workflow can't be accessed by the caller workflow.

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

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

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

@@ -18,6 +18,7 @@ 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/usage-limits-billing-and-administration.md
View File

@@ -16,6 +16,7 @@ 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 %}

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

@@ -22,6 +22,7 @@ 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,6 +18,7 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About workflow commands

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

@@ -16,6 +16,7 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## About YAML syntax for workflows
@@ -877,7 +878,7 @@ Using the `working-directory` keyword, you can specify the working directory of
### Using a specific shell
You can override the default shell settings in the runner's operating system using the `shell` keyword. You can use built-in `shell` keywords, or you can define a custom set of shell options. The shell command that is run internally executes a temporary file that contains the commands specifed in the `run` keyword.
You can override the default shell settings in the runner's operating system using the `shell` keyword. You can use built-in `shell` keywords, or you can define a custom set of shell options. The shell command that is run internally executes a temporary file that contains the commands specified in the `run` keyword.
| Supported platform | `shell` parameter | Description | Command run internally |
|--------------------|-------------------|-------------|------------------------|

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

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

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

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

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

@@ -17,6 +17,7 @@ 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

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

@@ -15,3 +15,5 @@ children:
- /removing-a-label-when-a-card-is-added-to-a-project-board-column
- /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,6 +17,7 @@ shortTitle: Move assigned issues
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

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

@@ -17,6 +17,7 @@ shortTitle: Remove label when adding card
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

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

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

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

@@ -14,6 +14,8 @@ 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.
## When do workflows run?

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

@@ -10,6 +10,7 @@ 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,6 +10,7 @@ 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,6 +11,7 @@ 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,6 +11,7 @@ shortTitle: Download workflow artifacts
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
{% ifversion fpt or ghes > 2.22 or ghae %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %}
{% ifversion ghes = 2.22 %} {% data variables.product.product_name %} stores full build logs and artifacts for 90 days.{% endif %}

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

@@ -26,3 +26,4 @@ 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,6 +11,7 @@ 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,6 +14,7 @@ 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

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

@@ -11,6 +11,7 @@ shortTitle: Remove workflow artifacts
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Deleting an artifact

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

@@ -8,6 +8,7 @@ versions:
ghae: '*'
---
{% data reusables.actions.ae-beta %}
## About required reviews in workflows

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

@@ -11,6 +11,7 @@ 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:

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

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

1
content/actions/migrating-to-github-actions/migrating-from-azure-pipelines-to-github-actions.md
View File

@@ -19,6 +19,7 @@ shortTitle: Migrate from Azure Pipelines
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.actions.ae-beta %}
## Introduction

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