From 9bb4bbfd45996714c81363d2aeee3d40a0da38b7 Mon Sep 17 00:00:00 2001 From: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> Date: Thu, 25 Jul 2024 11:20:40 -0700 Subject: [PATCH 1/6] Actions Usage Metrics - GA (#51528) Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> Co-authored-by: jc-clark --- .../usage-limits-billing-and-administration.md | 4 +--- ...-actions-usage-metrics-for-your-organization.md | 2 -- .../viewing-usage-metrics-for-github-actions.md | 13 +++++++++---- .../about-actions-usage-metrics-aggregation.md | 14 ++++++++++++++ .../actions/actions-usage-metrics-beta-note.md | 1 - 5 files changed, 24 insertions(+), 10 deletions(-) create mode 100644 data/reusables/actions/about-actions-usage-metrics-aggregation.md delete mode 100644 data/reusables/actions/actions-usage-metrics-beta-note.md diff --git a/content/actions/administering-github-actions/usage-limits-billing-and-administration.md b/content/actions/administering-github-actions/usage-limits-billing-and-administration.md index 95fb2bcb2175..7c962dfb8ab1 100644 --- a/content/actions/administering-github-actions/usage-limits-billing-and-administration.md +++ b/content/actions/administering-github-actions/usage-limits-billing-and-administration.md @@ -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 %} diff --git a/content/actions/administering-github-actions/viewing-github-actions-usage-metrics-for-your-organization.md b/content/actions/administering-github-actions/viewing-github-actions-usage-metrics-for-your-organization.md index 501c04d49484..547e755c36ba 100644 --- a/content/actions/administering-github-actions/viewing-github-actions-usage-metrics-for-your-organization.md +++ b/content/actions/administering-github-actions/viewing-github-actions-usage-metrics-for-your-organization.md @@ -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. diff --git a/content/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions.md b/content/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions.md index abadf0e68efd..fe90f3cf87bb 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions.md +++ b/content/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions.md @@ -8,25 +8,30 @@ versions: feature: actions-usage-metrics --- -{% data reusables.actions.actions-usage-metrics-beta-note %} - ## About {% data variables.product.prodname_actions %} usage metrics {% data reusables.actions.about-actions-usage-metrics %} {% data reusables.actions.actions-usage-metrics-not-billing-metrics %} - + ## Enabling access to {% data variables.product.prodname_actions %} usage metrics Organization owners can create custom organization roles to allow people to view {% data variables.product.prodname_actions %} usage metrics for their organization. To provide users with access, select the "View organization Actions usage metrics" role when creating a custom organization role. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." +## Understanding {% data variables.product.prodname_actions %} usage metrics aggregation + +{% data reusables.actions.about-actions-usage-metrics-aggregation %} + ## Viewing {% data variables.product.prodname_actions %} usage metrics +> [!NOTE] +There may be a discrepancy between the **Workflows** tab's job count and the **Jobs** tab's count due to differences in how unique jobs are identified. This does not affect the total minutes calculated. + {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.insights %} 1. In the "Insights" navigation menu, click **Actions Usage Metrics**. -1. Optionally, to select a time period to view usage metrics for, choose an option from the **Period** drop down menu at the top right of the page. +1. Optionally, to select a time period to view usage metrics for, choose an option from the **Period** drop down menu at the top right of the page. For more information, see "[Understanding {% data variables.product.prodname_actions %} usage metrics aggregation](#understanding-github-actions-usage-metrics-aggregation)." 1. Click on the tab that contains the usage metrics you would like to view. For more information, see "[About {% data variables.product.prodname_actions %} usage metrics](#about-github-actions-usage-metrics)." 1. Optionally, to filter the data displayed in a tab, create a filter. 1. Click on the **{% octicon "filter" aria-hidden="true" %} Filter** button. diff --git a/data/reusables/actions/about-actions-usage-metrics-aggregation.md b/data/reusables/actions/about-actions-usage-metrics-aggregation.md new file mode 100644 index 000000000000..8232b320c028 --- /dev/null +++ b/data/reusables/actions/about-actions-usage-metrics-aggregation.md @@ -0,0 +1,14 @@ +The time period selection feature allows you to view {% data variables.product.prodname_actions %} usage metrics over predefined periods, as detailed in the following table. These metrics include skipped runs and those that use zero minutes. Data is presented using Coordinated Universal Time (UTC) days. + +{% rowheaders %} + +| Period | Description | +|------------------------|------------------------------------------------------------------------------| +| Current week (Mon-Sun) | Data from Monday through the current day when the page is viewed. | +| Current month | Data from the first of the month to the current day when the page is viewed. | +| Last week | Data from the first day to the last day of the previous month. | +| Last 30 days | Data from the last 30 days to when the page is viewed. | +| Last 90 days | Data from the last 90 days to when the page is viewed. | +| Last year | Data aggregated for the last 12 months. | + +{% endrowheaders %} diff --git a/data/reusables/actions/actions-usage-metrics-beta-note.md b/data/reusables/actions/actions-usage-metrics-beta-note.md deleted file mode 100644 index 3df2f9bbec88..000000000000 --- a/data/reusables/actions/actions-usage-metrics-beta-note.md +++ /dev/null @@ -1 +0,0 @@ ->[!NOTE] {% data variables.product.prodname_actions %} usage metrics are in beta and subject to change. From 7ae63a67613c5f1b8f07509c977c66ba76fe362b Mon Sep 17 00:00:00 2001 From: Niky <20468684+nikymorg@users.noreply.github.com> Date: Thu, 25 Jul 2024 12:24:09 -0700 Subject: [PATCH 2/6] [Ecosystem Apps] Add longer list of internal apps (#51619) Co-authored-by: Hirsch Singhal <1666363+hpsin@users.noreply.github.com> --- .../using-oauth-apps/internal-oauth-apps.md | 17 ++++++++++------- .../using-github-apps/internal-github-apps.md | 17 ++++++++++++----- 2 files changed, 22 insertions(+), 12 deletions(-) diff --git a/content/apps/oauth-apps/using-oauth-apps/internal-oauth-apps.md b/content/apps/oauth-apps/using-oauth-apps/internal-oauth-apps.md index a7c60c4a63f7..18d74fc9c944 100644 --- a/content/apps/oauth-apps/using-oauth-apps/internal-oauth-apps.md +++ b/content/apps/oauth-apps/using-oauth-apps/internal-oauth-apps.md @@ -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 diff --git a/content/apps/using-github-apps/internal-github-apps.md b/content/apps/using-github-apps/internal-github-apps.md index d803b606b42f..209eef54590a 100644 --- a/content/apps/using-github-apps/internal-github-apps.md +++ b/content/apps/using-github-apps/internal-github-apps.md @@ -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 From 6ef351a3c0db38fb2306c2d4e8def487a0612f31 Mon Sep 17 00:00:00 2001 From: Jess Hosman <1183847+jhosman@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:27:47 -0600 Subject: [PATCH 3/6] Mixed Copilot plans within the same enterprise (#51697) --- .../about-billing-for-github-copilot.md | 4 +-- .../subscription-plans-for-github-copilot.md | 2 +- ...ot-for-organizations-in-your-enterprise.md | 19 ++++++++----- ...ot-for-organizations-in-your-enterprise.md | 26 +++++++++++------ ...ewing-copilot-usage-for-your-enterprise.md | 1 + ...scribing-to-copilot-for-your-enterprise.md | 28 +++++++++---------- .../upgrading-copilot-for-your-enterprise.md | 18 +++++++----- 7 files changed, 58 insertions(+), 40 deletions(-) diff --git a/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md b/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md index fd96f5cde425..19abb8e8367b 100644 --- a/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md +++ b/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md @@ -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)." diff --git a/content/copilot/about-github-copilot/subscription-plans-for-github-copilot.md b/content/copilot/about-github-copilot/subscription-plans-for-github-copilot.md index 7f1e58a51adc..860a09001ccb 100644 --- a/content/copilot/about-github-copilot/subscription-plans-for-github-copilot.md +++ b/content/copilot/about-github-copilot/subscription-plans-for-github-copilot.md @@ -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 %}. diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md index a50e99d2992d..f16c76bd9322 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md +++ b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md @@ -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: @@ -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)" diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md index 0c5b39c617f4..5ff6379f399b 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md +++ b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md @@ -2,8 +2,8 @@ title: Enabling Copilot for organizations in your enterprise shortTitle: Enable for organizations intro: 'Enable {% 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: @@ -12,18 +12,28 @@ redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise --- -Admins of enterprises that have a {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} subscription can enable {% data variables.product.prodname_copilot %} for all, none, or some organizations within the enterprise. +Owners of enterprises that have a {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} subscription can enable {% data variables.product.prodname_copilot %} for all, none, or some organizations within the enterprise. +For enterprises with a {% data variables.product.prodname_copilot_enterprise_short %} subscription, enterprise owners can choose to assign either {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} to individual organizations in the 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 enable {% data variables.product.prodname_copilot %} for all organizations in your enterprise, both current and future, select **Allow for: All organizations**. + * To enable {% data variables.product.prodname_copilot %} for all organizations in your enterprise, both current and future, select **Allow for all organizations**. * To enable {% 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 enable {% data variables.product.prodname_copilot %} for. Then, click the **Set organization permissions** dropdown and select **Enable** to grant {% data variables.product.prodname_copilot %} access for the specified organizations. - -1. Click **Save**. +1. If you selected **Allow for specific organizations**: + 1. Under "Access management", locate the organization for which you want to enable {% 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 **Enabled**. + * If your enterprise has a {% data variables.product.prodname_copilot_enterprise_short %} subscription, click either **Copilot: Enterprise** or **Copilot: Business** to assign a specific Copilot plan to the organization. ## Next steps -When {% data variables.product.prodname_copilot_short %} is enabled for an organization, owners of the organization can grant access to some or all members of the organization. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization)." +After you've enabled {% data variables.product.prodname_copilot_short %} for an organization in your enterprise, owners of the organization can grant access to some or all members of the organization. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization)." + +## 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)" diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-usage-for-your-enterprise.md b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-usage-for-your-enterprise.md index 48b1a8dc0955..c28791bd24cf 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-usage-for-your-enterprise.md +++ b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-usage-for-your-enterprise.md @@ -30,6 +30,7 @@ If you have a subscription to {% data variables.product.prodname_copilot_for_bus ### At the enterprise-level +{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} 1. Under "{% data variables.product.prodname_copilot_short %} monthly usage," view the breakdown of your {% data variables.product.prodname_copilot %} usage. diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md index f819369e0108..94424bed00c5 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md +++ b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md @@ -1,9 +1,9 @@ --- title: Subscribing to Copilot for your enterprise shortTitle: Subscribe -intro: 'Get access to {% data variables.product.prodname_copilot %} for your enterprise.' -permissions: Enterprise admins -product: '{% data variables.product.prodname_ghe_cloud %}' +intro: 'Enterprise owners can set up a {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} subscription for their enterprise.' +permissions: Enterprise owners +product: 'Enterprises on {% data variables.product.prodname_ghe_cloud %}' versions: feature: copilot-enterprise topics: @@ -13,22 +13,20 @@ redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise --- -Enterprise admins can set up a {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} subscription for their enterprise. For more information, see "[AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot)." - -If your enterprise is already subscribed to {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %}, you can upgrade or downgrade the subscription. See "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/upgrading-copilot-for-your-enterprise)" and "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/downgrading-copilot-for-your-enterprise)." - -For billing information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot-business-and-github-copilot-enterprise)" and "[AUTOTITLE](/billing/managing-your-github-billing-settings)." - -## Subscribing - >[!NOTE] > {% data reusables.copilot.signup-procedure-enterprise-msft-ea %} 1. Ensure you are signed in as an enterprise admin on {% data variables.product.prodname_dotcom_the_website %}. -1. Go to the [{% data variables.product.prodname_copilot_short %} plans page](https://github.com/features/copilot/plans). -1. Under "{% data variables.product.prodname_copilot_enterprise_short %}" or "{% data variables.product.prodname_copilot_business_short %}", click **Buy now**. -1. Follow the steps to sign up and enable {% data variables.product.prodname_copilot_short %} for organizations in your enterprise. +1. Navigate to the {% data variables.product.prodname_copilot_short %} signup page: + * For **{% data variables.product.prodname_copilot_business_short %}**, go to the [signup page for {% data variables.product.prodname_copilot_business_short %}](https://github.com/github-copilot/business_signup/choose_business_type). + * For **{% data variables.product.prodname_copilot_enterprise_short %}**, go to the [signup page for {% data variables.product.prodname_copilot_enterprise_short %}](https://github.com/github-copilot/enterprise_signup/choose_enterprise). +1. Follow the steps to sign up and enable {% data variables.product.prodname_copilot_short %} for organizations in your enterprise. If you purchased {% data variables.product.prodname_copilot_enterprise_short %}, you will be able 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. ## Next steps -To finish setting up {% data variables.product.prodname_copilot_short %} for your enterprise, see "[AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise)." +* To finish setting up {% data variables.product.prodname_copilot_short %} for your enterprise, see "[AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise)." +* For billing information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot-business-and-github-copilot-enterprise)" and "[AUTOTITLE](/billing/managing-your-github-billing-settings)." + +## Further reading + +* "[AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot)" diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/upgrading-copilot-for-your-enterprise.md b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/upgrading-copilot-for-your-enterprise.md index a4e0e55e46d2..b58ca2717ebc 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/upgrading-copilot-for-your-enterprise.md +++ b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/upgrading-copilot-for-your-enterprise.md @@ -1,9 +1,9 @@ --- title: Upgrading Copilot for your enterprise shortTitle: Upgrade subscription -intro: 'Change from {% data variables.product.prodname_copilot_business_short %} to {% data variables.product.prodname_copilot_enterprise %} for your enterprise.' -permissions: Enterprise admins -product: '{% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_copilot_business_short %}' +intro: 'Change your enterprise''s subscription from {% data variables.product.prodname_copilot_business_short %} to {% data variables.product.prodname_copilot_enterprise_short %}.' +permissions: Enterprise owners +product: 'Enterprises with a subscription to {% data variables.product.prodname_copilot_business_short %}' versions: feature: copilot-enterprise topics: @@ -12,10 +12,6 @@ redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/upgrading-copilot-for-your-enterprise --- -Enterprise admins can change their enterprise's {% data variables.product.prodname_copilot_short %} subscription from {% data variables.product.prodname_copilot_business_short %} to {% data variables.product.prodname_copilot_enterprise_short %}. - -When you upgrade, all users with a {% data variables.product.prodname_copilot_business_short %} seat will be upgraded to {% data variables.product.prodname_copilot_enterprise_short %}. Your enterprise will be charged pro rata for these seats for the rest of the billing cycle. - {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.copilot-tab %} @@ -25,3 +21,11 @@ When you upgrade, all users with a {% data variables.product.prodname_copilot_bu 1. In the dialog, click **Continue to billing summary**. 1. Review your updated billing summary, then click **Enable plan**. + +## Next steps + +After upgrading to {% data variables.product.prodname_copilot_enterprise_short %}, you can assign {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} to individual organizations in the enterprise. See "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise)." + +## Further reading + +* "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)" From ff12db2a75b7e70e7ed5f9392018ba4e99f18c0f Mon Sep 17 00:00:00 2001 From: Pj Metz <65838556+MetzinAround@users.noreply.github.com> Date: Thu, 25 Jul 2024 22:24:56 +0200 Subject: [PATCH 4/6] changed link for CE applications (#51758) --- .../applying-to-be-a-github-campus-expert.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md index 4c73a023cbe8..cac0a9790bcc 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md @@ -34,7 +34,7 @@ To become a {% data variables.product.prodname_student_leader_program_singular % ### Submitting your application form In the application form, we’re looking for students to tell us about the challenges their student community faces, what opportunities they want to build for their peers, and the potential they see for growth. -1. Go to [https://education.github.com/experts](https://education.github.com/experts). +1. Go to [https://education.github.com/campus_experts](https://education.github.com/campus_experts). 1. To learn if applications are open, click **Become a Campus Expert** {% octicon "arrow-right" aria-label="The right arrow icon" %}. 1. If applications are open, a new page will appear titled “Your journey starts here”. To start your application, click **Apply Now**. From d87d9af9e927bc7a65e6347af6b25bde827fe6ab Mon Sep 17 00:00:00 2001 From: Eden <25503691+GalaxyAllie@users.noreply.github.com> Date: Thu, 25 Jul 2024 21:33:27 +0100 Subject: [PATCH 5/6] Remove by default in two-dot vs three-dot description (#51737) Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com> --- .../about-comparing-branches-in-pull-requests.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md index 699c21b60bd5..233042fdf956 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md @@ -54,7 +54,7 @@ To simplify reviewing changes in a large pull request, you can filter the diff t ## Three-dot and two-dot Git diff comparisons -There are two comparison methods for the `git diff` command; two-dot (`git diff A..B`) and three-dot (`git diff A...B`). By default, pull requests on {% data variables.product.prodname_dotcom %} show a three-dot diff. +There are two comparison methods for the `git diff` command; two-dot (`git diff A..B`) and three-dot (`git diff A...B`). Pull requests on {% data variables.product.prodname_dotcom %} show a three-dot diff. ### Three-dot Git diff comparison From 7c08ff3c91fbb11789a1074fa088714e97bf9f22 Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Thu, 25 Jul 2024 13:39:06 -0700 Subject: [PATCH 6/6] Relocate articles into a new "Monitoring and troubleshooting" category (#51765) --- content/actions/index.md | 6 ++-- .../index.md | 16 +++------- .../about-monitoring-workflows.md} | 24 +++----------- .../adding-a-workflow-status-badge.md | 1 + .../monitoring-workflows/index.md | 17 ++++++++++ .../notifications-for-workflow-runs.md | 2 ++ .../using-the-visualization-graph.md | 1 + .../using-workflow-run-logs.md | 1 + .../viewing-job-execution-time.md | 1 + .../viewing-workflow-run-history.md | 1 + .../about-troubleshooting-workflows.md | 31 +++++++++++++++++++ .../enabling-debug-logging.md | 1 + .../troubleshooting-workflows/index.md | 13 ++++++++ ...working-with-support-for-github-actions.md | 4 ++- 14 files changed, 85 insertions(+), 34 deletions(-) rename content/actions/monitoring-and-troubleshooting-workflows/{about-monitoring-and-troubleshooting.md => monitoring-workflows/about-monitoring-workflows.md} (60%) rename content/actions/monitoring-and-troubleshooting-workflows/{ => monitoring-workflows}/adding-a-workflow-status-badge.md (97%) create mode 100644 content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/index.md rename content/actions/monitoring-and-troubleshooting-workflows/{ => monitoring-workflows}/notifications-for-workflow-runs.md (76%) rename content/actions/monitoring-and-troubleshooting-workflows/{ => monitoring-workflows}/using-the-visualization-graph.md (91%) rename content/actions/monitoring-and-troubleshooting-workflows/{ => monitoring-workflows}/using-workflow-run-logs.md (99%) rename content/actions/monitoring-and-troubleshooting-workflows/{ => monitoring-workflows}/viewing-job-execution-time.md (94%) rename content/actions/monitoring-and-troubleshooting-workflows/{ => monitoring-workflows}/viewing-workflow-run-history.md (96%) create mode 100644 content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md rename content/actions/monitoring-and-troubleshooting-workflows/{ => troubleshooting-workflows}/enabling-debug-logging.md (97%) create mode 100644 content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/index.md rename content/actions/monitoring-and-troubleshooting-workflows/{ => troubleshooting-workflows}/working-with-support-for-github-actions.md (97%) diff --git a/content/actions/index.md b/content/actions/index.md index 2c9743b3c768..83e156544de2 100644 --- a/content/actions/index.md +++ b/content/actions/index.md @@ -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 @@ -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 diff --git a/content/actions/monitoring-and-troubleshooting-workflows/index.md b/content/actions/monitoring-and-troubleshooting-workflows/index.md index d5c08d41a9df..5406af09b895 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/index.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/index.md @@ -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 %} diff --git a/content/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting.md b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/about-monitoring-workflows.md similarity index 60% rename from content/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting.md rename to content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/about-monitoring-workflows.md index 6d385253594b..9cec21768a5c 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/about-monitoring-workflows.md @@ -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 @@ -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. diff --git a/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge.md similarity index 97% rename from content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md rename to content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge.md index 387da242a2da..2857b0565dbd 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge.md @@ -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: '*' diff --git a/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/index.md b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/index.md new file mode 100644 index 000000000000..15e9f846d035 --- /dev/null +++ b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/index.md @@ -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 +--- diff --git a/content/actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs.md b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/notifications-for-workflow-runs.md similarity index 76% rename from content/actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs.md rename to content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/notifications-for-workflow-runs.md index 085df4473799..3c09d2db10e1 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/notifications-for-workflow-runs.md @@ -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 %} diff --git a/content/actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph.md b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-the-visualization-graph.md similarity index 91% rename from content/actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph.md rename to content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-the-visualization-graph.md index 3ddc9bf8d26c..c4bc5f5486bd 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-the-visualization-graph.md @@ -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: '*' diff --git a/content/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs.md b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-workflow-run-logs.md similarity index 99% rename from content/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs.md rename to content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-workflow-run-logs.md index 222e29689462..9deda463f111 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/using-workflow-run-logs.md @@ -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: '*' diff --git a/content/actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time.md b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/viewing-job-execution-time.md similarity index 94% rename from content/actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time.md rename to content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/viewing-job-execution-time.md index 4d9baf8af234..027c0100e1fd 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/viewing-job-execution-time.md @@ -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: '*' diff --git a/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/viewing-workflow-run-history.md similarity index 96% rename from content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md rename to content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/viewing-workflow-run-history.md index f801c5a925df..8964e48e31a0 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/viewing-workflow-run-history.md @@ -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: '*' diff --git a/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md new file mode 100644 index 000000000000..0a784bc9c750 --- /dev/null +++ b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md @@ -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)." diff --git a/content/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging.md b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging.md similarity index 97% rename from content/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging.md rename to content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging.md index f877c13f7a57..db0a4b0af71d 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging.md @@ -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: '*' diff --git a/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/index.md b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/index.md new file mode 100644 index 000000000000..749f5a8f7278 --- /dev/null +++ b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/index.md @@ -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 +--- diff --git a/content/actions/monitoring-and-troubleshooting-workflows/working-with-support-for-github-actions.md b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/working-with-support-for-github-actions.md similarity index 97% rename from content/actions/monitoring-and-troubleshooting-workflows/working-with-support-for-github-actions.md rename to content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/working-with-support-for-github-actions.md index 989a3630c323..cf758961165d 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/working-with-support-for-github-actions.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/working-with-support-for-github-actions.md @@ -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 %}.