Skip to content

Commit

Permalink
Merge pull request github#34092 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Jul 25, 2024
2 parents 62feaca + 7c08ff3 commit 603486f
Show file tree
Hide file tree
Showing 30 changed files with 191 additions and 98 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,7 @@ In addition to the usage limits, you must ensure that you use {% data variables.

## {% data variables.product.prodname_actions %} usage metrics

{% data reusables.actions.actions-usage-metrics-beta-note %}

If you are on a {% data variables.product.prodname_ghe_cloud %} plan, organization owners and users with the "View organization Actions usage metrics" permission can view {% data variables.product.prodname_actions %} usage metrics for their organization. These metrics can help understand how and where your Actions minutes are being used. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)."
Organization owners and users with the "View organization Actions usage metrics" permission can view {% data variables.product.prodname_actions %} usage metrics for their organization. These metrics can help you understand how and where your Actions minutes are being used. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)."

When you view usage metrics, it is important to remember that {% data reusables.actions.actions-usage-metrics-not-billing-metrics %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ redirect_from:
- /actions/monitoring-and-troubleshooting-workflows/viewing-github-actions-usage-metrics-for-your-organization
---

{% data reusables.actions.actions-usage-metrics-beta-note %}

If you are on a {% data variables.product.prodname_ghe_cloud %} plan, {% data reusables.actions.about-actions-usage-metrics %}

For more information about how to use {% data variables.product.prodname_actions %} usage metrics, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)" in the {% data variables.product.prodname_ghe_cloud %} documentation.
6 changes: 3 additions & 3 deletions content/actions/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "{% data variables.product.prodname_actions %} documentation"
shortTitle: "{% data variables.product.prodname_actions %}"
title: '{% data variables.product.prodname_actions %} documentation'
shortTitle: '{% data variables.product.prodname_actions %}'
intro: 'Automate, customize, and execute your software development workflows right in your repository with {% data variables.product.prodname_actions %}. You can discover, create, and share actions to perform any job you''d like, including CI/CD, and combine actions in a completely customized workflow.'
introLinks:
overview: /actions/learn-github-actions/understanding-github-actions
Expand All @@ -12,7 +12,7 @@ featuredLinks:
- /actions/automating-builds-and-tests/about-continuous-integration
- /actions/deployment/about-deployments/deploying-with-github-actions
- /actions/publishing-packages/about-packaging-with-github-actions
- /actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting
- /actions/monitoring-and-troubleshooting-workflows
guideCards:
- /actions/learn-github-actions/using-starter-workflows
- /actions/publishing-packages/publishing-nodejs-packages
Expand Down
16 changes: 5 additions & 11 deletions content/actions/monitoring-and-troubleshooting-workflows/index.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,18 @@
---
title: Monitoring and troubleshooting workflows
shortTitle: Monitor & troubleshoot
intro: 'You can view the status and results of each step in your workflow, debug a failed workflow, search and download logs, and view billable job execution minutes.'
intro: 'You can view the status and results of each step in your workflow, debug a failed workflow, and search and download logs.'
redirect_from:
- /articles/viewing-your-repository-s-workflows
- /articles/viewing-your-repositorys-workflows
- /actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting
versions:
fpt: '*'
ghes: '*'
ghec: '*'
children:
- /about-monitoring-and-troubleshooting
- /using-the-visualization-graph
- /adding-a-workflow-status-badge
- /viewing-workflow-run-history
- /viewing-job-execution-time
- /using-workflow-run-logs
- /enabling-debug-logging
- /notifications-for-workflow-runs
- /working-with-support-for-github-actions
- /monitoring-workflows
- /troubleshooting-workflows
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: About monitoring and troubleshooting
intro: 'You can use the tools in {% data variables.product.prodname_actions %} to monitor and debug your workflows.'
title: About monitoring workflows
intro: 'You can use the tools in {% data variables.product.prodname_actions %} to monitor your workflows.'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
shortTitle: About monitoring and troubleshooting
shortTitle: About monitoring
---

{% data reusables.actions.enterprise-github-hosted-runners %}

## Monitoring your workflows
Expand Down Expand Up @@ -45,21 +45,7 @@ To identify how long a job took to run, you can view its execution time. For mor

You can view the status of each job and step in a workflow. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."

## Troubleshooting your workflows

### Using workflow run logs

Each workflow run generates activity logs that you can view, search, and download. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs)."

### Enabling debug logging

If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)."

### Canceling a workflow

If you attempt to cancel a workflow and the cancellation doesn't succeed, make sure you aren't using the `always` expression. The `always` expression causes a workflow step to run even when the workflow is canceled, which results in a hanging cancellation. For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions#always)".

## Monitoring and troubleshooting self-hosted runners
## Monitoring self-hosted runners

If you use self-hosted runners, you can view their activity and diagnose common issues.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: Add a status badge
intro: You can display a status badge in your repository to indicate the status of your workflows.
redirect_from:
- /actions/managing-workflow-runs/adding-a-workflow-status-badge
- /actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Monitoring workflows
shortTitle: Monitor
intro: 'You can monitor {% data variables.product.prodname_actions %} workflows by using tools like the visualization graph and run logs.'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
children:
- /about-monitoring-workflows
- /notifications-for-workflow-runs
- /using-the-visualization-graph
- /viewing-workflow-run-history
- /viewing-job-execution-time
- /adding-a-workflow-status-badge
- /using-workflow-run-logs
---
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
redirect_from:
- /actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: Visualization graph
intro: Every workflow run generates a real-time graph that illustrates the run progress. You can use this graph to monitor and debug workflows.
redirect_from:
- /actions/managing-workflow-runs/using-the-visualization-graph
- /actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: Workflow run logs
intro: 'You can view, search, and download the logs for each job in a workflow run.'
redirect_from:
- /actions/managing-workflow-runs/using-workflow-run-logs
- /actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: View job execution time
intro: 'You can view the execution time of a job, including the billable minutes that a job accrued.'
redirect_from:
- /actions/managing-workflow-runs/viewing-job-execution-time
- /actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time
versions:
fpt: '*'
ghec: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: Workflow run history
intro: You can view logs for each run of a workflow. Logs include the status for each job and step in a workflow.
redirect_from:
- /actions/managing-workflow-runs/viewing-workflow-run-history
- /actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: About troubleshooting workflows
intro: 'You can use the tools in {% data variables.product.prodname_actions %} to debug your workflows.'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
shortTitle: About troubleshooting
---

{% data reusables.actions.enterprise-github-hosted-runners %}

## Troubleshooting your workflows

### Using workflow run logs

Each workflow run generates activity logs that you can view, search, and download. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs)."

### Enabling debug logging

If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)."

### Canceling a workflow

If you attempt to cancel a workflow and the cancellation doesn't succeed, make sure you aren't using the `always` expression. The `always` expression causes a workflow step to run even when the workflow is canceled, which results in a hanging cancellation. For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions#always)".

## Troubleshooting self-hosted runners

If you use self-hosted runners, you can view their activity and diagnose common issues.

For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners)."
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: Enable debug logging
intro: 'If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging.'
redirect_from:
- /actions/managing-workflow-runs/enabling-debug-logging
- /actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Troubleshooting workflows
shortTitle: Troubleshoot
intro: 'You can troubleshoot {% data variables.product.prodname_actions %} workflows by using tools like debug logging.'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
children:
- /about-troubleshooting-workflows
- /enabling-debug-logging
- /working-with-support-for-github-actions
---
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ type: reference
topics:
- Actions
- Support
shortTitle: Working with {% data variables.contact.github_support %}
shortTitle: 'Working with {% data variables.contact.github_support %}'
redirect_from:
- /actions/monitoring-and-troubleshooting-workflows/working-with-support-for-github-actions
---

You can [contact {% data variables.contact.github_support %}](/support/contacting-github-support) for assistance with {% data variables.product.prodname_actions %}.
Expand Down
17 changes: 10 additions & 7 deletions content/apps/oauth-apps/using-oauth-apps/internal-oauth-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,16 @@ These internal apps will appear in the user security log, but will not appear in

These {% data variables.product.prodname_oauth_apps %} are :

* Git Credentials Manager
* Gist
* Git Credential Manager
* GitHub Android
* {% data variables.product.prodname_cli %}
* {% data variables.product.prodname_desktop %}
* GitHub for Unity
* GitHub for VSCode
* GitHub CLI
* GitHub Codespaces for JetBrains
* GitHub Desktop
* GitHub Education
* github-importer-production
* GitHub iOS
* GitHub Mac
* GitHub Windows
* GitHub Support
* JetBrains IDE Integration
* Visual Studio
* Visual Studio Code
17 changes: 12 additions & 5 deletions content/apps/using-github-apps/internal-github-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,17 @@ These internal apps will appear in the user security log, but will not appear in

These {% data variables.product.prodname_github_apps %} are:

* {% data variables.product.prodname_classroom %}
* VSCode Auth Provider
* Actions
* Dependabot
* Git Src Migrator
* MS Teams
* GitHub Advanced Security
* GitHub Classroom
* GitHub Codespaces
* GitHub Copilot Plugin
* GitHub Merge Queue
* GitHub Pages
* GitHub Project Automation
* GitHub Team Synchronization
* Microsoft Teams for GitHub
* OpenGraph (`custom-og-image`)
* Slack
* {% data variables.product.prodname_codespaces %}
* {% data variables.product.prodname_copilot_short %} plugin
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ shortTitle: Billing for GitHub Copilot

{% endif %}

## About billing for {% data variables.product.prodname_copilot %}
## About billing for {% data variables.product.prodname_copilot_short %}

You can set up a {% data variables.product.prodname_copilot %} subscription for your personal account, or for an organization or enterprise.

* **For your personal account**, you can set up a subscription to {% data variables.product.prodname_copilot_for_individuals %}.
* **For an organization**, you can set up a subscription to {% data variables.product.prodname_copilot_for_business %}, then grant access to members.
* **For an enterprise on {% data variables.product.prodname_ghe_cloud %}**, you can set up a subscription to {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %}, then allow organizations to grant access to members.
* **For an enterprise on {% data variables.product.prodname_ghe_cloud %}**, you can set up a subscription to {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %}, then allow organizations to grant access to members. Enterprises with a {% data variables.product.prodname_copilot_enterprise_short %} subscription can assign either {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} to each organization in the enterprise.

> [!NOTE] A free subscription for {% data variables.product.prodname_copilot %} is available to verified students, teachers, and maintainers of popular open-source repositories on {% data variables.product.company_short %}. See "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ shortTitle: Subscriptions

* **{% data variables.product.prodname_copilot_for_individuals %}** is available to individual {% data variables.product.company_short %} customers who don't have access to {% data variables.product.prodname_copilot_short %} through an organization or enterprise.
* **{% data variables.product.prodname_copilot_for_business %}** is available for organizations with a {% data variables.product.prodname_free_team %} or {% data variables.product.prodname_team %} plan, or enterprises on {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.prodname_copilot_business_short %} gives organizations and enterprises control over {% data variables.product.prodname_copilot_short %} policies, including which members can use {% data variables.product.prodname_copilot_short %}.
* **{% data variables.product.prodname_copilot_enterprise %}** is available for enterprises on {% data variables.product.prodname_ghe_cloud %}. In addition to all of the {% data variables.product.prodname_copilot_business_short %} features, {% data variables.product.prodname_copilot_enterprise_short %} provides additional AI features on {% data variables.product.company_short %}.
* **{% data variables.product.prodname_copilot_enterprise %}** is available for enterprises on {% data variables.product.prodname_ghe_cloud %}. In addition to all of the {% data variables.product.prodname_copilot_business_short %} features, {% data variables.product.prodname_copilot_enterprise_short %} provides additional AI features on {% data variables.product.company_short %}. With this subscription plan you can choose to assign either {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} to each individual organization in the enterprise.

{% data variables.product.prodname_copilot_short %} is not currently available for {% data variables.product.prodname_ghe_server %}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Disabling Copilot for organizations in your enterprise
shortTitle: Disable for organizations
intro: 'Disable {% data variables.product.prodname_copilot %} for some or all of the organizations in your enterprise.'
permissions: Enterprise admins
product: '{% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %}'
permissions: Enterprise owners
product: 'Enterprises with a subscription to {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %}'
versions:
feature: copilot-enterprise
topics:
Expand All @@ -12,16 +12,21 @@ redirect_from:
- /copilot/managing-copilot/managing-copilot-for-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise
---

{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.copilot-tab %}
1. In the "{% data variables.product.prodname_copilot_short %} is active in your enterprise" section, configure the access for your {% data variables.product.prodname_copilot %} subscription.
* To disable {% data variables.product.prodname_copilot %} for all organizations in your enterprise, select **Disabled**.
* To disable {% data variables.product.prodname_copilot %} for specific organizations, select **Allow for specific organizations**.

1. If you selected **Allow for specific organizations**, select the organizations you want to disable {% data variables.product.prodname_copilot %} for. Then, click the **Set organization permissions** dropdown and select **Disable** to deny {% data variables.product.prodname_copilot %} access for the specified organizations.
1. If you selected **Allow for specific organizations**:

![Screenshot of the {% data variables.product.prodname_copilot %} policy page. The organization permissions dropdown is outlined in dark orange.](/assets/images/help/copilot/set-org-permissions-enterprise.png)
1. Under "Access management", locate the organization for which you want to disable {% data variables.product.prodname_copilot_short %}.
1. To the right of the organization name, select the **Copilot** dropdown menu.
* If your enterprise has a {% data variables.product.prodname_copilot_business_short %} subscription, click **Disabled**.
* If your enterprise has a {% data variables.product.prodname_copilot_enterprise_short %} subscription, click **Remove access**.

1. Review your selection.
* If you selected **Disabled**, you will see a warning that disabling {% data variables.product.prodname_copilot %} will revoke access for all organizations and members. To confirm, click **Confirm and save**.
* If you selected **Allow for specific organizations**, click **Save**.
## Further reading

* "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)"
* "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise)"
Loading

0 comments on commit 603486f

Please sign in to comment.