From 86fffa168add74e17eebcf8f8a7374cd00543538 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Tue, 23 May 2023 15:59:58 +0100 Subject: [PATCH] Minor changes to GitHub user docs for public preview of GHAzDo (#36965) Co-authored-by: Laura Coursen --- .../using-the-codeql-cli/about-the-codeql-cli.md | 4 +++- .../using-the-codeql-cli/creating-codeql-databases.md | 8 ++++++++ .../about-github-advanced-security.md | 10 +++++++++- data/features/ghas-for-azure-devops.yml | 7 +++++++ data/reusables/advanced-security/ghas-for-azdo-link.md | 2 ++ data/reusables/gated-features/codeql.md | 2 +- data/reusables/gated-features/ghas-ghec.md | 4 +++- data/reusables/gated-features/ghas.md | 4 +++- data/variables/product.yml | 1 + 9 files changed, 37 insertions(+), 5 deletions(-) create mode 100644 data/features/ghas-for-azure-devops.yml create mode 100644 data/reusables/advanced-security/ghas-for-azdo-link.md diff --git a/content/code-security/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.md b/content/code-security/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.md index 3ed810c22f7e..e2293703b02f 100644 --- a/content/code-security/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.md +++ b/content/code-security/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.md @@ -32,7 +32,9 @@ source community - Develop and test custom {% data variables.product.prodname_codeql %} queries to use in your own analyses For information about using the {% data variables.product.prodname_codeql_cli %}, see -"[Getting started with the {% data variables.product.prodname_codeql_cli %}](/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli)." +"[AUTOTITLE](/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli)." + +You can also use {% data variables.product.prodname_actions %} or Azure DevOps pipelines to scan code using the {% data variables.product.prodname_codeql_cli %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository)" or [Configure {% data variables.product.prodname_ghas_azdo %}](https://learn.microsoft.com/en-us/azure/devops/repos/security/configure-github-advanced-security-features) in Microsoft Learn. ## About the {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_codeql %} license diff --git a/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases.md b/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases.md index e156d64d76a9..e0a8118d987e 100644 --- a/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases.md +++ b/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases.md @@ -290,6 +290,14 @@ Once you have created a {% data variables.product.prodname_codeql %} database us ### Example of creating a {% data variables.product.prodname_codeql %} database using indirect build tracing +{% ifversion ghas-for-azure-devops %} +{% note %} + +**Note:** If you use Azure DevOps pipelines, the simplest way to create a {% data variables.product.prodname_codeql %} database is to use {% data variables.product.prodname_ghas_azdo %}. For documentation, see [Configure {% data variables.product.prodname_ghas_azdo %}](https://learn.microsoft.com/en-us/azure/devops/repos/security/configure-github-advanced-security-features) in Microsoft Learn. + +{% endnote %} +{% endif %} + The following example shows how you could use indirect build tracing in an Azure DevOps pipeline to create a {% data variables.product.prodname_codeql %} database: ``` diff --git a/content/get-started/learning-about-github/about-github-advanced-security.md b/content/get-started/learning-about-github/about-github-advanced-security.md index f8572f585132..9b1d0d59b2ec 100644 --- a/content/get-started/learning-about-github/about-github-advanced-security.md +++ b/content/get-started/learning-about-github/about-github-advanced-security.md @@ -16,10 +16,18 @@ shortTitle: GitHub Advanced Security --- ## About {% data variables.product.prodname_GH_advanced_security %} -{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% ifversion not ghae %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a {% data variables.product.prodname_GH_advanced_security %}{% ifversion fpt or ghec %} license to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. +{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% ifversion not ghae %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a {% data variables.product.prodname_GH_advanced_security %} (GHAS){% ifversion fpt or ghec %} license to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. {% ifversion ghes %}For information about buying a license for {% data variables.product.prodname_GH_advanced_security %}, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% elsif ghec %}For information about buying a license for {% data variables.product.prodname_GH_advanced_security %}, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security)."{% elsif ghae %}There is no charge for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_ghe_managed %} during the beta release.{% elsif fpt %}To purchase a {% data variables.product.prodname_GH_advanced_security %} license, you must be using {% data variables.product.prodname_enterprise %}. For information about upgrading to {% data variables.product.prodname_enterprise %} with {% data variables.product.prodname_GH_advanced_security %}, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products)" and "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} +{% ifversion ghas-for-azure-devops %} +{% note %} + +**Note:** If you want to try the preview of {% data variables.product.prodname_GH_advanced_security %} with Azure Repos, see [{% data variables.product.prodname_GH_advanced_security %} & Azure DevOps](https://resources.github.com/ghazdo/) in our resources site. For documentation, see [Configure {% data variables.product.prodname_ghas_azdo %}](https://learn.microsoft.com/en-us/azure/devops/repos/security/configure-github-advanced-security-features) in Microsoft Learn. + +{% endnote %} +{% endif %} + ## About {% data variables.product.prodname_advanced_security %} features A {% data variables.product.prodname_GH_advanced_security %} license provides the following additional features: diff --git a/data/features/ghas-for-azure-devops.yml b/data/features/ghas-for-azure-devops.yml new file mode 100644 index 000000000000..ef07964fb733 --- /dev/null +++ b/data/features/ghas-for-azure-devops.yml @@ -0,0 +1,7 @@ +# Reference: #9903 +# GitHub Advanced Security for Azure DevOps +versions: + fpt: '*' + ghec: '*' + ghes: '*' + ghae: '*' diff --git a/data/reusables/advanced-security/ghas-for-azdo-link.md b/data/reusables/advanced-security/ghas-for-azdo-link.md new file mode 100644 index 000000000000..0926160585ab --- /dev/null +++ b/data/reusables/advanced-security/ghas-for-azdo-link.md @@ -0,0 +1,2 @@ +{% ifversion ghas-for-azure-devops %}For information about {% data variables.product.prodname_ghas_azdo %}, see [Configure {% data variables.product.prodname_ghas_azdo %}](https://learn.microsoft.com/en-us/azure/devops/repos/security/configure-github-advanced-security-features) in Microsoft Learn. +{% endif %} \ No newline at end of file diff --git a/data/reusables/gated-features/codeql.md b/data/reusables/gated-features/codeql.md index 50ef42d84649..39de012e511b 100644 --- a/data/reusables/gated-features/codeql.md +++ b/data/reusables/gated-features/codeql.md @@ -1,3 +1,3 @@ GitHub {% data variables.product.prodname_codeql %} is licensed on a per-user basis upon installation. You can use {% data variables.product.prodname_codeql %} only for certain tasks under the license restrictions. For more information, see "[AUTOTITLE](/code-security/codeql-cli/using-the-codeql-cli/about-the-codeql-cli#about-the-github-codeql-license)." -If you have a {% data variables.product.prodname_enterprise %} account and GitHub Advanced Security license, you can use {% data variables.product.prodname_codeql %} for automated analysis, continuous integration and continuous delivery. You can create an enterprise account by contacting the [sales team](https://enterprise.github.com/contact). {% data reusables.advanced-security.more-info-ghas %} +If you have a GitHub Advanced Security license, you can use {% data variables.product.prodname_codeql %} for automated analysis, continuous integration, and continuous delivery. {% data reusables.advanced-security.more-info-ghas %} diff --git a/data/reusables/gated-features/ghas-ghec.md b/data/reusables/gated-features/ghas-ghec.md index 1ba86202a435..e9f0e7a5b97c 100644 --- a/data/reusables/gated-features/ghas-ghec.md +++ b/data/reusables/gated-features/ghas-ghec.md @@ -1 +1,3 @@ -{% data variables.product.prodname_GH_advanced_security %} is available for enterprise accounts on {% data variables.product.prodname_ghe_cloud %}.{% ifversion fpt or ghec %} Some features of {% data variables.product.prodname_GH_advanced_security %} are also available for public repositories on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products)."{% endif %} +{% data variables.product.prodname_GH_advanced_security %} is available for enterprise accounts on {% data variables.product.prodname_ghe_cloud %}.{% ifversion fpt or ghec %} Some features of {% data variables.product.prodname_GH_advanced_security %} are also available for public repositories on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products)."{% endif %}{% ifversion ghas-for-azure-devops %}

{% endif %} + +{% data reusables.advanced-security.ghas-for-azdo-link %} diff --git a/data/reusables/gated-features/ghas.md b/data/reusables/gated-features/ghas.md index a9270c9831cb..ba7bfcdecfe0 100644 --- a/data/reusables/gated-features/ghas.md +++ b/data/reusables/gated-features/ghas.md @@ -1 +1,3 @@ -{% data variables.product.prodname_GH_advanced_security %} is available for enterprise accounts on {% data variables.product.prodname_ghe_cloud %}{% ifversion ghae %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}.{% ifversion fpt or ghec %} Some features of {% data variables.product.prodname_GH_advanced_security %} are also available for public repositories on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products)."{% else %} For more information about upgrading your {% data variables.product.prodname_ghe_server %} instance, see "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)" and refer to the [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) to find the upgrade path from your current release version.{% endif %} +{% data variables.product.prodname_GH_advanced_security %} is available for enterprise accounts on {% data variables.product.prodname_ghe_cloud %}{% ifversion ghae %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}.{% ifversion fpt or ghec %} Some features of {% data variables.product.prodname_GH_advanced_security %} are also available for public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products)." +{% ifversion ghas-for-azure-devops %}

{% endif %} +{% data reusables.advanced-security.ghas-for-azdo-link %} diff --git a/data/variables/product.yml b/data/variables/product.yml index 7cb6e38b0f3d..1dc1ed7f0348 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -162,6 +162,7 @@ prodname_matching_fund: 'GitHub Sponsors Matching Fund' # GitHub Advanced Security prodname_GH_advanced_security: 'GitHub Advanced Security' prodname_advanced_security: 'Advanced Security' +prodname_ghas_azdo: 'GitHub Advanced Security for Azure DevOps' # Codespaces prodname_codespaces: 'Codespaces'