diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 38926a7dd8..a10ad565e4 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -32,12 +32,6 @@ "postCreateCommand": "npm ci && npm run build", // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. - "remoteUser": "node", - - // Test restricting low-spec machines - "hostRequirements": { - "cpus": 8, - "memory": "8gb", - "storage": "32gb" - } + "remoteUser": "node" + } diff --git a/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/nodejs.tsx b/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/nodejs.tsx index 1992008c04..903ebb49c0 100644 --- a/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/nodejs.tsx +++ b/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/nodejs.tsx @@ -24,11 +24,11 @@ const article: PlaygroundArticleT = { id: '0', }, type: 'default', - title: 'Starting with the Node.js workflow template', + title: 'Using the Node.js starter workflow', content: dedent` - GitHub provides a Node.js workflow template that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the template. For more information, see the [Node.js workflow template](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml). + GitHub provides a Node.js starter workflow that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the starter workflow. For more information, see the [Node.js starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml). - To get started quickly, add the template to the \`.github/workflows\` directory of your repository. The example workflow assumes that the default branch for your repository is \`main\`. + To get started quickly, add the starter workflow to the \`.github/workflows\` directory of your repository. The example workflow assumes that the default branch for your repository is \`main\`. `, }, { @@ -39,7 +39,7 @@ const article: PlaygroundArticleT = { type: 'default', title: 'Running on a different operating system', content: dedent` - The starter workflow template configures jobs to run on Linux, using the GitHub-hosted \`ubuntu-latest\` runners. You can change the \`runs-on\` key to run your jobs on a different operating system. For example, you can use the GitHub-hosted Windows runners. + The starter workflow configures jobs to run on Linux, using the GitHub-hosted \`ubuntu-latest\` runners. You can change the \`runs-on\` key to run your jobs on a different operating system. For example, you can use the GitHub-hosted Windows runners. \`\`\`yaml runs-on: windows-latest @@ -66,7 +66,7 @@ const article: PlaygroundArticleT = { The \`setup-node\` action takes a Node.js version as an input and configures that version on the runner. The \`setup-node\` action finds a specific version of Node.js from the tools cache on each runner and adds the necessary binaries to \`PATH\`, which persists for the rest of the job. Using the \`setup-node\` action is the recommended way of using Node.js with GitHub Actions because it ensures consistent behavior across different runners and different versions of Node.js. If you are using a self-hosted runner, you must install Node.js and add it to \`PATH\`. - The template includes a matrix strategy that builds and tests your code with four Node.js versions: 10.x, 12.x, 14.x, and 15.x. The 'x' is a wildcard character that matches the latest minor and patch release available for a version. Each version of Node.js specified in the \`node-version\` array creates a job that runs the same steps. + The starter workflow includes a matrix strategy that builds and tests your code with four Node.js versions: 10.x, 12.x, 14.x, and 15.x. The 'x' is a wildcard character that matches the latest minor and patch release available for a version. Each version of Node.js specified in the \`node-version\` array creates a job that runs the same steps. Each job can access the value defined in the matrix \`node-version\` array using the \`matrix\` context. The \`setup-node\` action uses the context as the \`node-version\` input. The \`setup-node\` action configures each job with a different Node.js version before building and testing code. For more information about matrix strategies and contexts, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" and "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions)." `, diff --git a/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/python.tsx b/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/python.tsx index 52a4dfb7be..d5fcdeeb81 100644 --- a/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/python.tsx +++ b/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/python.tsx @@ -28,11 +28,11 @@ const article: PlaygroundArticleT = { codeBlock: { id: '0', }, - title: 'Starting with the Python workflow template', + title: 'Using the Python starter workflow', content: dedent` - GitHub provides a Python workflow template that should work for most Python projects. This guide includes examples that you can use to customize the template. For more information, see the [Python workflow template](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml). + GitHub provides a Python starter workflow that should work for most Python projects. This guide includes examples that you can use to customize the starter workflow. For more information, see the [Python starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml). - To get started quickly, add the template to the \`.github/workflows\` directory of your repository. + To get started quickly, add the starter workflow to the \`.github/workflows\` directory of your repository. `, }, { @@ -206,7 +206,7 @@ const article: PlaygroundArticleT = { For this example, you will need to create two [PyPI API tokens](https://pypi.org/help/#apitoken). You can use secrets to store the access tokens or credentials needed to publish your package. For more information, see "[Creating and using encrypted secrets](/github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." - For more information about the template workflow, see [\`python-publish\`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml). + For more information about the starter workflow, see [\`python-publish\`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml). `, }, ], diff --git a/content/actions/automating-builds-and-tests/about-continuous-integration.md b/content/actions/automating-builds-and-tests/about-continuous-integration.md index 393d8c7c60..5c660e6ecb 100644 --- a/content/actions/automating-builds-and-tests/about-continuous-integration.md +++ b/content/actions/automating-builds-and-tests/about-continuous-integration.md @@ -39,19 +39,19 @@ You can configure your CI workflow to run when a {% data variables.product.prodn {% data variables.product.product_name %} runs your CI tests and provides the results of each test in the pull request, so you can see whether the change in your branch introduces an error. When all CI tests in a workflow pass, the changes you pushed are ready to be reviewed by a team member or merged. When a test fails, one of your changes may have caused the failure. -When you set up CI in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends CI workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests. You can use the CI workflow template suggested by {% data variables.product.product_name %}, customize the suggested template, or create your own custom workflow file to run your CI tests. +When you set up CI in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends CI workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a starter workflow that installs your Node.js packages and runs your tests. You can use the CI starter workflow suggested by {% data variables.product.product_name %}, customize the suggested starter workflow, or create your own custom workflow file to run your CI tests. -![Screenshot of suggested continuous integration templates](/assets/images/help/repository/ci-with-actions-template-picker.png) +![Screenshot of suggested continuous integration starter workflows](/assets/images/help/repository/ci-with-actions-template-picker.png) In addition to helping you set up CI workflows for your project, you can use {% data variables.product.prodname_actions %} to create workflows across the full software development life cycle. For example, you can use actions to deploy, package, or release your project. For more information, see "[About {% data variables.product.prodname_actions %}](/articles/about-github-actions)." For a definition of common terms, see "[Core concepts for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions)." -## Workflow templates +## Starter workflow -{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks. +{% data variables.product.product_name %} offers CI starter workflow for a variety of languages and frameworks. -Browse the complete list of CI workflow templates offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}. +Browse the complete list of CI starter workflow offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}. ## Further reading diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md index e064761894..ccf04b5c79 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md @@ -40,11 +40,11 @@ We recommend that you have a basic understanding of Java and the Ant framework. {% data reusables.actions.enterprise-setup-prereq %} -## Starting with an Ant workflow template +## Using the Ant starter workflow -{% data variables.product.prodname_dotcom %} provides an Ant workflow template that will work for most Ant-based Java projects. For more information, see the [Ant workflow template](https://github.com/actions/starter-workflows/blob/main/ci/ant.yml). +{% data variables.product.prodname_dotcom %} provides an Ant starter workflow that will work for most Ant-based Java projects. For more information, see the [Ant starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/ant.yml). -To get started quickly, you can choose the preconfigured Ant template when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." +To get started quickly, you can choose the preconfigured Ant starter workflow when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." You can also add this workflow manually by creating a new file in the `.github/workflows` directory of your repository. @@ -76,7 +76,7 @@ This workflow performs the following steps: 2. The `setup-java` step configures the Java 11 JDK by Adoptium. 3. The "Build with Ant" step runs the default target in your `build.xml` in non-interactive mode. -The default workflow templates are excellent starting points when creating your build and test workflow, and you can customize the template to suit your project’s needs. +The default starter workflows are excellent starting points when creating your build and test workflow, and you can customize the starter workflow to suit your project’s needs. {% data reusables.github-actions.example-github-runner %} diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md index 74fb4ffb74..53d8174806 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md @@ -40,11 +40,11 @@ We recommend that you have a basic understanding of Java and the Gradle framewor {% data reusables.actions.enterprise-setup-prereq %} -## Starting with a Gradle workflow template +## Using the Gradle starter workflow -{% data variables.product.prodname_dotcom %} provides a Gradle workflow template that will work for most Gradle-based Java projects. For more information, see the [Gradle workflow template](https://github.com/actions/starter-workflows/blob/main/ci/gradle.yml). +{% data variables.product.prodname_dotcom %} provides a Gradle starter workflow that will work for most Gradle-based Java projects. For more information, see the [Gradle starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/gradle.yml). -To get started quickly, you can choose the preconfigured Gradle template when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." +To get started quickly, you can choose the preconfigured Gradle starter workflow when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." You can also add this workflow manually by creating a new file in the `.github/workflows` directory of your repository. @@ -79,7 +79,7 @@ This workflow performs the following steps: 3. The "Validate Gradle wrapper" step validates the checksums of Gradle Wrapper JAR files present in the source tree. 4. The "Build with Gradle" step runs the `gradlew` wrapper script to ensure that your code builds, tests pass, and a package can be created. -The default workflow templates are excellent starting points when creating your build and test workflow, and you can customize the template to suit your project’s needs. +The default starter workflows are excellent starting points when creating your build and test workflow, and you can customize the starter workflow to suit your project’s needs. {% data reusables.github-actions.example-github-runner %} diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md index a8403ce752..bc44e08de5 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md @@ -40,11 +40,11 @@ We recommend that you have a basic understanding of Java and the Maven framework {% data reusables.actions.enterprise-setup-prereq %} -## Starting with a Maven workflow template +## Using the Maven starter workflow -{% data variables.product.prodname_dotcom %} provides a Maven workflow template that will work for most Maven-based Java projects. For more information, see the [Maven workflow template](https://github.com/actions/starter-workflows/blob/main/ci/maven.yml). +{% data variables.product.prodname_dotcom %} provides a Maven starter workflow that will work for most Maven-based Java projects. For more information, see the [Maven starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/maven.yml). -To get started quickly, you can choose the preconfigured Maven template when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." +To get started quickly, you can choose the preconfigured Maven starter workflow when you create a new workflow. For more information, see the "[{% data variables.product.prodname_actions %} quickstart](/actions/quickstart)." You can also add this workflow manually by creating a new file in the `.github/workflows` directory of your repository. @@ -76,7 +76,7 @@ This workflow performs the following steps: 2. The `setup-java` step configures the Java 11 JDK by Adoptium. 3. The "Build with Maven" step runs the Maven `package` target in non-interactive mode to ensure that your code builds, tests pass, and a package can be created. -The default workflow templates are excellent starting points when creating your build and test workflow, and you can customize the template to suit your project’s needs. +The default starter workflows are excellent starting points when creating your build and test workflow, and you can customize the starter workflow to suit your project’s needs. {% data reusables.github-actions.example-github-runner %} diff --git a/content/actions/automating-builds-and-tests/building-and-testing-net.md b/content/actions/automating-builds-and-tests/building-and-testing-net.md index ba114a3e74..774d757556 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-net.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-net.md @@ -28,11 +28,11 @@ You should already be familiar with YAML syntax and how it's used with {% data v We recommend that you have a basic understanding of the .NET Core SDK. For more information, see [Getting started with .NET](https://dotnet.microsoft.com/learn). -## Starting with the .NET workflow template +## Using the .NET starter workflow -{% data variables.product.prodname_dotcom %} provides a .NET workflow template that should work for most .NET projects, and this guide includes examples that show you how to customize this template. For more information, see the [.NET workflow template](https://github.com/actions/setup-dotnet). +{% data variables.product.prodname_dotcom %} provides a .NET starter workflow that should work for most .NET projects, and this guide includes examples that show you how to customize this starter workflow. For more information, see the [.NET starter workflow](https://github.com/actions/setup-dotnet). -To get started quickly, add the template to the `.github/workflows` directory of your repository. +To get started quickly, add the starter workflow to the `.github/workflows` directory of your repository. {% raw %} ```yaml diff --git a/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md b/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md index 8460d39730..ecb2e61aa8 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md @@ -36,11 +36,11 @@ We recommend that you have a basic understanding of Node.js, YAML, workflow conf {% data reusables.actions.enterprise-setup-prereq %} -## Starting with the Node.js workflow template +## Using the Node.js starter workflow -{% data variables.product.prodname_dotcom %} provides a Node.js workflow template that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the template. For more information, see the [Node.js workflow template](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml). +{% data variables.product.prodname_dotcom %} provides a Node.js starter workflow that will work for most Node.js projects. This guide includes npm and Yarn examples that you can use to customize the starter workflow. For more information, see the [Node.js starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml). -To get started quickly, add the template to the `.github/workflows` directory of your repository. The workflow shown below assumes that the default branch for your repository is `main`. +To get started quickly, add the starter workflow to the `.github/workflows` directory of your repository. The workflow shown below assumes that the default branch for your repository is `main`. {% raw %} ```yaml{:copy} @@ -81,7 +81,7 @@ The easiest way to specify a Node.js version is by using the `setup-node` action The `setup-node` action takes a Node.js version as an input and configures that version on the runner. The `setup-node` action finds a specific version of Node.js from the tools cache on each runner and adds the necessary binaries to `PATH`, which persists for the rest of the job. Using the `setup-node` action is the recommended way of using Node.js with {% data variables.product.prodname_actions %} because it ensures consistent behavior across different runners and different versions of Node.js. If you are using a self-hosted runner, you must install Node.js and add it to `PATH`. -The template includes a matrix strategy that builds and tests your code with four Node.js versions: 10.x, 12.x, 14.x, and 15.x. The 'x' is a wildcard character that matches the latest minor and patch release available for a version. Each version of Node.js specified in the `node-version` array creates a job that runs the same steps. +The starter workflow includes a matrix strategy that builds and tests your code with four Node.js versions: 10.x, 12.x, 14.x, and 15.x. The 'x' is a wildcard character that matches the latest minor and patch release available for a version. Each version of Node.js specified in the `node-version` array creates a job that runs the same steps. Each job can access the value defined in the matrix `node-version` array using the `matrix` context. The `setup-node` action uses the context as the `node-version` input. The `setup-node` action configures each job with a different Node.js version before building and testing code. For more information about matrix strategies and contexts, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)" and "[Contexts](/actions/learn-github-actions/contexts)." diff --git a/content/actions/automating-builds-and-tests/building-and-testing-python.md b/content/actions/automating-builds-and-tests/building-and-testing-python.md index bdbeef71ff..c67f6a545b 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-python.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-python.md @@ -42,11 +42,11 @@ We recommend that you have a basic understanding of Python, PyPy, and pip. For m {% data reusables.actions.enterprise-setup-prereq %} -## Starting with the Python workflow template +## Using the Python starter workflow -{% data variables.product.prodname_dotcom %} provides a Python workflow template that should work for most Python projects. This guide includes examples that you can use to customize the template. For more information, see the [Python workflow template](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml). +{% data variables.product.prodname_dotcom %} provides a Python starter workflow that should work for most Python projects. This guide includes examples that you can use to customize the starter workflow. For more information, see the [Python starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml). -To get started quickly, add the template to the `.github/workflows` directory of your repository. +To get started quickly, add the starter workflow to the `.github/workflows` directory of your repository. {% raw %} ```yaml{:copy} @@ -426,4 +426,4 @@ jobs: password: {% raw %}${{ secrets.PYPI_API_TOKEN }}{% endraw %} ``` -For more information about the template workflow, see [`python-publish`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml). +For more information about the starter workflow, see [`python-publish`](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml). diff --git a/content/actions/automating-builds-and-tests/building-and-testing-ruby.md b/content/actions/automating-builds-and-tests/building-and-testing-ruby.md index 6da09a7717..09d888b839 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-ruby.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-ruby.md @@ -29,11 +29,11 @@ We recommend that you have a basic understanding of Ruby, YAML, workflow configu - [Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions) - [Ruby in 20 minutes](https://www.ruby-lang.org/en/documentation/quickstart/) -## Starting with the Ruby workflow template +## Using the Ruby starter workflow -{% data variables.product.prodname_dotcom %} provides a Ruby workflow template that will work for most Ruby projects. For more information, see the [Ruby workflow template](https://github.com/actions/starter-workflows/blob/master/ci/ruby.yml). +{% data variables.product.prodname_dotcom %} provides a Ruby starter workflow that will work for most Ruby projects. For more information, see the [Ruby starter workflow](https://github.com/actions/starter-workflows/blob/master/ci/ruby.yml). -To get started quickly, add the template to the `.github/workflows` directory of your repository. The workflow shown below assumes that the default branch for your repository is `main`. +To get started quickly, add the starter workflow to the `.github/workflows` directory of your repository. The workflow shown below assumes that the default branch for your repository is `main`. ```yaml {% data reusables.actions.actions-not-certified-by-github-comment %} diff --git a/content/actions/automating-builds-and-tests/building-and-testing-swift.md b/content/actions/automating-builds-and-tests/building-and-testing-swift.md index 8bbcaef747..c343875e70 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-swift.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-swift.md @@ -31,11 +31,11 @@ You should already be familiar with YAML syntax and how it's used with {% data v We recommend that you have a basic understanding of Swift packages. For more information, see "[Swift Packages](https://developer.apple.com/documentation/swift_packages)" in the Apple developer documentation. -## Starting with the Swift workflow template +## Using the Swift starter workflow -{% data variables.product.prodname_dotcom %} provides a Swift workflow template that should work for most Swift projects, and this guide includes examples that show you how to customize this template. For more information, see the [Swift workflow template](https://github.com/actions/starter-workflows/blob/main/ci/swift.yml). +{% data variables.product.prodname_dotcom %} provides a Swift starter workflow that should work for most Swift projects, and this guide includes examples that show you how to customize this starter workflow. For more information, see the [Swift starter workflow](https://github.com/actions/starter-workflows/blob/main/ci/swift.yml). -To get started quickly, add the template to the `.github/workflows` directory of your repository. +To get started quickly, add the starter workflow to the `.github/workflows` directory of your repository. {% raw %} ```yaml{:copy} diff --git a/content/actions/deployment/about-deployments/about-continuous-deployment.md b/content/actions/deployment/about-deployments/about-continuous-deployment.md index cf534d337e..e941449aa8 100644 --- a/content/actions/deployment/about-deployments/about-continuous-deployment.md +++ b/content/actions/deployment/about-deployments/about-continuous-deployment.md @@ -40,7 +40,7 @@ You can configure your CD workflow to run when a {% data variables.product.produ {% endif %} -## Workflow templates and third party actions +## Starter workflows and third party actions {% data reusables.actions.cd-templates-actions %} diff --git a/content/actions/guides.md b/content/actions/guides.md index 3a445c387b..f6cec21fcb 100644 --- a/content/actions/guides.md +++ b/content/actions/guides.md @@ -20,7 +20,7 @@ includeGuides: - /actions/quickstart - /actions/learn-github-actions/introduction-to-github-actions - /actions/creating-actions/creating-a-docker-container-action - - /actions/learn-github-actions/using-workflow-templates + - /actions/learn-github-actions/using-starter-workflows - /actions/automating-builds-and-tests/building-and-testing-python - /actions/automating-builds-and-tests/building-and-testing-nodejs - /actions/publishing-packages/about-packaging-with-github-actions diff --git a/content/actions/index.md b/content/actions/index.md index 874053eb2b..8828a7a41c 100644 --- a/content/actions/index.md +++ b/content/actions/index.md @@ -13,7 +13,7 @@ featuredLinks: - /actions/guides/about-packaging-with-github-actions - /actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting guideCards: - - /actions/guides/setting-up-continuous-integration-using-workflow-templates + - /actions/learn-github-actions/using-starter-workflows - /actions/guides/publishing-nodejs-packages - /actions/guides/building-and-testing-powershell popular: diff --git a/content/actions/learn-github-actions/creating-starter-workflows-for-your-organization.md b/content/actions/learn-github-actions/creating-starter-workflows-for-your-organization.md new file mode 100644 index 0000000000..4be314080b --- /dev/null +++ b/content/actions/learn-github-actions/creating-starter-workflows-for-your-organization.md @@ -0,0 +1,99 @@ +--- +title: Creating starter workflows for your organization +shortTitle: Creating starter workflows +intro: Learn how you can create starter workflows to help people in your team add new workflows more easily. +redirect_from: + - /actions/configuring-and-managing-workflows/sharing-workflow-templates-within-your-organization + - /actions/learn-github-actions/creating-workflow-templates +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - Workflows + - CI +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +## Overview + +{% data reusables.actions.workflow-organization-templates %} + +## Creating a starter workflow + +Starter workflows can be created by users with write access to the organization's `.github` repository. These can then be used by organization members who have permission to create workflows. + +{% ifversion fpt %} +Starter workflows created by users can only be used to create workflows in public repositories. Organizations using {% data variables.product.prodname_ghe_cloud %} can also use starter workflows to create workflows in private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/learn-github-actions/creating-starter-workflows-for-your-organization). +{% endif %} + +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} +{% note %} + +**Note:** To avoid duplication among starter workflows you can call reusable workflows from within a workflow. This can help make your workflows easier to maintain. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." + +{% endnote %} +{% endif %} + +This procedure demonstrates how to create a starter workflow and metadata file. The metadata file describes how the starter workflows will be presented to users when they are creating a new workflow. + +1. If it doesn't already exist, create a new public repository named `.github` in your organization. +2. Create a directory named `workflow-templates`. +3. Create your new workflow file inside the `workflow-templates` directory. + + If you need to refer to a repository's default branch, you can use the `$default-branch` placeholder. When a workflow is created the placeholder will be automatically replaced with the name of the repository's default branch. + + For example, this file named `octo-organization-ci.yml` demonstrates a basic workflow. + + ```yaml + name: Octo Organization CI + + on: + push: + branches: [ $default-branch ] + pull_request: + branches: [ $default-branch ] + + jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Run a one-line script + run: echo Hello from Octo Organization + ``` +4. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: + ```yaml + { + "name": "Octo Organization Workflow", + "description": "Octo Organization CI starter workflow.", + "iconName": "example-icon", + "categories": [ + "Go" + ], + "filePatterns": [ + "package.json$", + "^Dockerfile", + ".*\\.md$" + ] + } + ``` + * `name` - **Required.** The name of the workflow. This is displayed in the list of available workflows. + * `description` - **Required.** The description of the workflow. This is displayed in the list of available workflows. + * `iconName` - **Optional.** Specifies an icon for the workflow that's displayed in the list of workflows. The `iconName` must be the name of an SVG file, without the file name extension, stored in the `workflow-templates` directory. For example, an SVG file named `example-icon.svg` is referenced as `example-icon`. + * `categories` - **Optional.** Defines the language category of the workflow. When a user views the available starter workflows for a repository, the workflows that match the identified language for the project are featured more prominently. For information on the available language categories, see https://github.com/github/linguist/blob/master/lib/linguist/languages.yml. + * `filePatterns` - **Optional.** Allows the workflow to be used if the user's repository has a file in its root directory that matches a defined regular expression. + +To add another starter workflow, add your files to the same `workflow-templates` directory. For example: + +![Workflow files](/assets/images/help/images/workflow-template-files.png) + +## Next steps + +To continue learning about {% data variables.product.prodname_actions %}, see "[Using workflow ](/actions/learn-github-actions/using-starter-workflows)." diff --git a/content/actions/learn-github-actions/creating-workflow-templates.md b/content/actions/learn-github-actions/creating-workflow-templates.md deleted file mode 100644 index 3ad83990c7..0000000000 --- a/content/actions/learn-github-actions/creating-workflow-templates.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Creating workflow templates -shortTitle: Creating templates -intro: Learn how you can create workflow templates to help people in your team add new workflows more easily. -redirect_from: - - /actions/configuring-and-managing-workflows/sharing-workflow-templates-within-your-organization -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## Overview - -{% data reusables.actions.workflow-organization-templates %} - -## Creating a workflow template - -Workflow templates can be created by users with write access to the organization's `.github` repository. The templates can then be used by organization members who have permission to create workflows. - -{% ifversion fpt %} -Your workflow templates can be used to create workflows in public repositories only. Organizations using {% data variables.product.prodname_ghe_cloud %} can also use workflow templates to create workflows in private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/learn-github-actions/creating-workflow-templates). -{% endif %} - -{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -{% note %} - -**Note:** To avoid duplication in workflows created from a template you can call reusable workflows from within a workflow template. This can help make your workflows easier to maintain. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." - -{% endnote %} -{% endif %} - -This procedure demonstrates how to create a workflow template and metadata file. The metadata file describes how the template is presented to users when they are creating a new workflow. - -1. If it doesn't already exist, create a new public repository named `.github` in your organization. -2. Create a directory named `workflow-templates`. -3. Create your new workflow file inside the `workflow-templates` directory. - - If you need to refer to a repository's default branch, you can use the `$default-branch` placeholder. When a workflow is created using your template, the placeholder will be automatically replaced with the name of the repository's default branch. - - For example, this file named `octo-organization-ci.yml` demonstrates a basic workflow. - - ```yaml - name: Octo Organization CI - - on: - push: - branches: [ $default-branch ] - pull_request: - branches: [ $default-branch ] - - jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - - name: Run a one-line script - run: echo Hello from Octo Organization - ``` -4. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: - ```yaml - { - "name": "Octo Organization Workflow", - "description": "Octo Organization CI workflow template.", - "iconName": "example-icon", - "categories": [ - "Go" - ], - "filePatterns": [ - "package.json$", - "^Dockerfile", - ".*\\.md$" - ] - } - ``` - * `name` - **Required.** The name of the workflow template. This is displayed in the list of available templates. - * `description` - **Required.** The description of the workflow template. This is displayed in the list of available templates. - * `iconName` - **Optional.** Defines an icon for the workflow's entry in the template list. The `iconName` must be an SVG icon of the same name, and must be stored in the `workflow-templates` directory. For example, a SVG file named `example-icon.svg` is referenced as `example-icon`. - * `categories` - **Optional.** Defines the language category of the workflow. When a user views the available templates, those templates that match the same language will feature more prominently. For information on the available language categories, see https://github.com/github/linguist/blob/master/lib/linguist/languages.yml. - * `filePatterns` - **Optional.** Allows the template to be used if the user's repository has a file in its root directory that matches a defined regular expression. - -To add another workflow template, add your files to the same `workflow-templates` directory. For example: - -![Workflow template files](/assets/images/help/images/workflow-template-files.png) - -## Next steps - -To continue learning about {% data variables.product.prodname_actions %}, see "[Using workflow templates](/actions/learn-github-actions/using-workflow-templates)." diff --git a/content/actions/learn-github-actions/index.md b/content/actions/learn-github-actions/index.md index e45322bcff..a6a2c06226 100644 --- a/content/actions/learn-github-actions/index.md +++ b/content/actions/learn-github-actions/index.md @@ -34,8 +34,8 @@ children: - /essential-features-of-github-actions - /managing-complex-workflows - /sharing-workflows-secrets-and-runners-with-your-organization - - /creating-workflow-templates - - /using-workflow-templates + - /creating-starter-workflows-for-your-organization + - /using-starter-workflows - /reusing-workflows - /events-that-trigger-workflows - /expressions diff --git a/content/actions/learn-github-actions/managing-complex-workflows.md b/content/actions/learn-github-actions/managing-complex-workflows.md index e44a1d367c..ed8322bb5a 100644 --- a/content/actions/learn-github-actions/managing-complex-workflows.md +++ b/content/actions/learn-github-actions/managing-complex-workflows.md @@ -170,7 +170,7 @@ To learn more about {% data variables.product.prodname_dotcom %}-hosted runner l You can configure environments with protection rules and secrets. Each job in a workflow can reference a single environment. Any protection rules configured for the environment must pass before a job referencing the environment is sent to a runner. For more information, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." {% endif %} -## Using a workflow template +## Using starter workflows {% data reusables.actions.workflow-template-overview %} @@ -178,7 +178,7 @@ You can configure environments with protection rules and secrets. Each job in a {% data reusables.repositories.actions-tab %} 1. If your repository already has existing workflows: In the upper-left corner, click **New workflow**. ![Create a new workflow](/assets/images/help/repository/actions-new-workflow.png) -1. Under the name of the template you'd like to use, click **Set up this workflow**. +1. Under the name of the starter workflow you'd like to use, click **Set up this workflow**. ![Set up this workflow](/assets/images/help/settings/actions-create-starter-workflow.png) ## Next steps diff --git a/content/actions/learn-github-actions/reusing-workflows.md b/content/actions/learn-github-actions/reusing-workflows.md index 9bf5bb7bdf..33a4d0e6a9 100644 --- a/content/actions/learn-github-actions/reusing-workflows.md +++ b/content/actions/learn-github-actions/reusing-workflows.md @@ -32,11 +32,11 @@ If you reuse a workflow from a different repository, any actions in the called w When a reusable workflow is triggered by a caller workflow, the `github` context is always associated with the caller workflow. The called workflow is automatically granted access to `github.token` and `secrets.GITHUB_TOKEN`. For more information about the `github` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)." -### Reusable workflows and workflow templates +### Reusable workflows and starter workflow -Workflow templates allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When people create a new workflow, they can choose a template and some or all of the work of writing the workflow will be done for them. Inside workflow templates, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a tag or branch name when referencing the reusable workflow then you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)." +Starter workflow allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When people create a new workflow, they can choose a starter workflow and some or all of the work of writing the workflow will be done for them. Inside starter workflow, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a tag or branch name when referencing the reusable workflow then you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)." -For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." +For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)." ## Access to reusable workflows diff --git a/content/actions/learn-github-actions/sharing-workflows-secrets-and-runners-with-your-organization.md b/content/actions/learn-github-actions/sharing-workflows-secrets-and-runners-with-your-organization.md index f48ee6acd8..7ce98f5613 100644 --- a/content/actions/learn-github-actions/sharing-workflows-secrets-and-runners-with-your-organization.md +++ b/content/actions/learn-github-actions/sharing-workflows-secrets-and-runners-with-your-organization.md @@ -1,7 +1,7 @@ --- title: 'Sharing workflows, secrets, and runners with your organization' shortTitle: Sharing workflows with your organization -intro: 'Learn how you can use organization features to collaborate with your team, by sharing workflow templates, secrets, and self-hosted runners.' +intro: 'Learn how you can use organization features to collaborate with your team, by sharing starter workflow, secrets, and self-hosted runners.' redirect_from: - /actions/learn-github-actions/sharing-workflows-with-your-organization versions: @@ -17,11 +17,11 @@ type: how_to ## Overview -If you need to share workflows and other {% data variables.product.prodname_actions %} features with your team, then consider collaborating within a {% data variables.product.prodname_dotcom %} organization. An organization allows you to centrally store and manage secrets, artifacts, and self-hosted runners. You can also create workflow templates in the `.github` repository and share them with other users in your organization. +If you need to share workflows and other {% data variables.product.prodname_actions %} features with your team, then consider collaborating within a {% data variables.product.prodname_dotcom %} organization. An organization allows you to centrally store and manage secrets, artifacts, and self-hosted runners. You can also create starter workflow in the `.github` repository and share them with other users in your organization. -## Using workflow templates +## Using starter workflows -{% data reusables.actions.workflow-organization-templates %} For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." +{% data reusables.actions.workflow-organization-templates %} For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)." {% data reusables.actions.reusable-workflows %} @@ -51,4 +51,4 @@ For more information, see "[Managing access to self-hosted runners using groups] ## Next steps -To continue learning about {% data variables.product.prodname_actions %}, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." +To continue learning about {% data variables.product.prodname_actions %}, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)." diff --git a/content/actions/learn-github-actions/using-starter-workflows.md b/content/actions/learn-github-actions/using-starter-workflows.md new file mode 100644 index 0000000000..9af782bd97 --- /dev/null +++ b/content/actions/learn-github-actions/using-starter-workflows.md @@ -0,0 +1,54 @@ +--- +title: Using starter workflows +intro: '{% data variables.product.product_name %} provides starter workflows for a variety of languages and tooling.' +redirect_from: + - /articles/setting-up-continuous-integration-using-github-actions + - /github/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions + - /actions/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions + - /actions/building-and-testing-code-with-continuous-integration/setting-up-continuous-integration-using-github-actions + - /actions/guides/setting-up-continuous-integration-using-workflow-templates + - /actions/learn-github-actions/using-workflow-templates +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: tutorial +topics: + - Workflows + - CI + - CD +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +## About starter workflows + +{% data variables.product.product_name %} offers starter workflows for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a starter workflow file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant starter workflows.{% endif %} + +You can also create your own starter workflow to share with your organization. These starter workflows will appear alongside the {% data variables.product.product_name %}-provided starter workflows. For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)." + +## Using starter workflows + +Anyone with write permission to a repository can set up {% data variables.product.prodname_actions %} starter workflows for CI/CD or other automation. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.actions-tab %} +1. If you already have a workflow in your repository, click **New workflow**. +1. Find the starter workflow that you want to use, then click **Set up this workflow**.{% if actions-starter-template-ui %} To help you find the starter workflow that you want, you can search for keywords or filter by category.{% endif %} +1. If the starter workflow contains comments detailing additional setup steps, follow these steps. Many of the starter workflow have corresponding guides. For more information, see [the {% data variables.product.prodname_actions %} guides](/actions/guides)." +1. Some starter workflows use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the starter workflow uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." +1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs. +1. Click **Start commit**. +1. Write a commit message and decide whether to commit directly to the default branch or to open a pull request. + +## Further reading + +- "[About continuous integration](/articles/about-continuous-integration)" +- "[Managing workflow runs](/actions/managing-workflow-runs)" +- "[About monitoring and troubleshooting](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)" +- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" +{% ifversion fpt or ghec %} +- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" +{% endif %} diff --git a/content/actions/learn-github-actions/using-workflow-templates.md b/content/actions/learn-github-actions/using-workflow-templates.md deleted file mode 100644 index f7685fa3f0..0000000000 --- a/content/actions/learn-github-actions/using-workflow-templates.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Using workflow templates -shortTitle: Using templates -intro: '{% data variables.product.product_name %} provides workflow templates for a variety of languages and tooling.' -redirect_from: - - /articles/setting-up-continuous-integration-using-github-actions - - /github/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/building-and-testing-code-with-continuous-integration/setting-up-continuous-integration-using-github-actions - - /actions/guides/setting-up-continuous-integration-using-workflow-templates -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI - - CD ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## About workflow templates - -{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant workflow templates.{% endif %} - -You can also create your own workflow templates to share with your organization. These templates will appear alongside the {% data variables.product.product_name %} workflow templates. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." - -## Using workflow templates - -Anyone with write permission to a repository can set up {% data variables.product.prodname_actions %} workflows for CI/CD or other automation. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.actions-tab %} -1. If you already have a workflow in your repository, click **New workflow**. -1. Find the template that you want to use, then click **Set up this workflow**.{% if actions-starter-template-ui %} To help you find the template that you want, you can search for keywords or filter by category.{% endif %} -1. If the workflow template contains comments detailing additional setup steps, follow these steps. Many of the templates have corresponding guides. For more information, see [the {% data variables.product.prodname_actions %} guides](/actions/guides)." -1. Some workflow templates use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." -1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs. -1. Click **Start commit**. -1. Write a commit message and decide whether to commit directly to the default branch or to open a pull request. - -## Further reading - -- "[About continuous integration](/articles/about-continuous-integration)" -- "[Managing workflow runs](/actions/managing-workflow-runs)" -- "[About monitoring and troubleshooting](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)" -- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" -{% ifversion fpt or ghec %} -- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" -{% endif %} diff --git a/content/actions/quickstart.md b/content/actions/quickstart.md index 38bf3fdf13..28d20b78f7 100644 --- a/content/actions/quickstart.md +++ b/content/actions/quickstart.md @@ -76,7 +76,7 @@ Committing the workflow file to a branch in your repository triggers the `push` For example, you can see the list of files in your repository: ![Example action detail](/assets/images/help/repository/actions-quickstart-log-detail.png) -## More workflow templates +## More starter workflows {% data reusables.actions.workflow-template-overview %} diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md index 6114f313f6..4d3112bf29 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md @@ -72,7 +72,7 @@ Think about how your enterprise can use features of {% data variables.product.pr With reusable workflows, your team can call one workflow from another workflow, avoiding exact duplication. Reusable workflows promote best practice by helping your team use workflows that are well designed and have already been tested. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." {% endif %} -To provide a starting place for developers building new workflows, you can use workflow templates. This not only saves time for your developers, but promotes consistency and best practice across your enterprise. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." +To provide a starting place for developers building new workflows, you can use starter workflows. This not only saves time for your developers, but promotes consistency and best practice across your enterprise. For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)." Whenever your workflow developers want to use an action that's stored in a private repository, they must configure the workflow to clone the repository first. To reduce the number of repositories that must be cloned, consider grouping commonly used actions in a single repository. For more information, see "[About custom actions](/actions/creating-actions/about-custom-actions#choosing-a-location-for-your-action)." diff --git a/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md b/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md new file mode 100644 index 0000000000..1eb32e030f --- /dev/null +++ b/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md @@ -0,0 +1,40 @@ +--- +title: Default environment variables for your codespace +shortTitle: Default environment variables +product: '{% data reusables.gated-features.codespaces %}' +permissions: '{% data reusables.codespaces.availability %}' +intro: '{% data variables.product.prodname_dotcom %} sets default environment variables for each codespace.' +versions: + fpt: '*' + ghec: '*' +type: overview +topics: + - Codespaces + - Fundamentals + - Developer +--- + +## About default environment variables + +{% data variables.product.prodname_dotcom %} sets default environment variables for every codespace. Commands run in codespaces can create, read, and modify environment variables. + +{% note %} + +**Note**: Environment variables are case-sensitive. + +{% endnote %} + +## List of default environment variables + +| Environment variable | Description | +| ---------------------|------------ | +| `CODESPACE_NAME` | The name of the codespace For example, `monalisa-github-hello-world-2f2fsdf2e` | +| `CODESPACES` | Always `true` while in a codespace | +| `GIT_COMMITTER_EMAIL` | The email for the "author" field of future `git` commits. | +| `GIT_COMMITTER_NAME` | The name for the "committer" field of future `git` commits. | +| `GITHUB_API_URL` | Returns the API URL. For example, `{% data variables.product.api_url_code %}`. | +| `GITHUB_GRAPHQL_URL` | Returns the GraphQL API URL. For example, `{% data variables.product.graphql_url_code %}`. | +| `GITHUB_REPOSITORY` | The owner and repository name. For example, `octocat/Hello-World`. | +| `GITHUB_SERVER_URL`| Returns the URL of the {% data variables.product.product_name %} server. For example, `https://{% data variables.product.product_url %}`. | +| `GITHUB_TOKEN` | A signed auth token representing the user in the codespace. You can use this to make authenticated calls to the GitHub API. For more information, see "[Authentication](/codespaces/codespaces-reference/security-in-codespaces#authentication)." | +| `GITHUB_USER` | The name of the user that initiated the codespace. For example, `octocat`. | \ No newline at end of file diff --git a/content/codespaces/developing-in-codespaces/index.md b/content/codespaces/developing-in-codespaces/index.md index 0558dd88ff..64e671622b 100644 --- a/content/codespaces/developing-in-codespaces/index.md +++ b/content/codespaces/developing-in-codespaces/index.md @@ -15,6 +15,7 @@ children: - /using-codespaces-for-pull-requests - /deleting-a-codespace - /forwarding-ports-in-your-codespace + - /default-environment-variables-for-your-codespace - /connecting-to-a-private-network - /using-codespaces-in-visual-studio-code - /using-codespaces-with-github-cli diff --git a/content/issues/tracking-your-work-with-issues/creating-an-issue.md b/content/issues/tracking-your-work-with-issues/creating-an-issue.md index cb346ba181..d4ad5f88ae 100644 --- a/content/issues/tracking-your-work-with-issues/creating-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/creating-an-issue.md @@ -91,7 +91,7 @@ You can open a new issue from a specific line or lines of code in a file or pull {% data reusables.repositories.navigate-to-repo %} 1. Locate the code you want to reference in an issue: - To open an issue about code in a file, navigate to the file. - - To open an issue about code in a pull request, navigate to the pull request and click {% octicon "diff" aria-label="The file diff icon" %} **Files changed**. Then, browse to the file that contains the code you want include in your comment, and click **View**. + - To open an issue about code in a pull request, navigate to the pull request and click {% octicon "diff" aria-label="The file diff icon" %} **Files changed**. Then, browse to the file that contains the code you want included in your comment, and click **View**. {% data reusables.repositories.choose-line-or-range %} 4. To the left of the code range, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab octicon" %}. In the drop-down menu, click **Reference in new issue**. ![Kebab menu with option to open a new issue from a selected line](/assets/images/help/repository/open-new-issue-specific-line.png) diff --git a/content/issues/trying-out-the-new-projects-experience/creating-a-project.md b/content/issues/trying-out-the-new-projects-experience/creating-a-project.md index e68a41f2ed..c3e5acb974 100644 --- a/content/issues/trying-out-the-new-projects-experience/creating-a-project.md +++ b/content/issues/trying-out-the-new-projects-experience/creating-a-project.md @@ -82,7 +82,7 @@ You can archive an item to keep the context about the item in the project but re 1. Select the item(s) to archive or delete. To select multiple items, do one of the following: - `cmd + click` (Mac) or `ctrl + click` (Windows/Linux) each item. - - Select an item then `shift + arrow-up` or `shift + arrow-down` to select additional items above or below the intitially selected item. + - Select an item then `shift + arrow-up` or `shift + arrow-down` to select additional items above or below the initially selected item. - Select an item then `shift + click` another item to select all items between the two items. - Enter `cmd + a` (Mac) or `ctrl + a` (Windows/Linux) to select all items in a column in a board layout or all items in a table layout. 2. To archive all selected items, enter `e`. To delete all selected items, enter `del`. Alternatively, select the {% octicon "triangle-down" aria-label="the item menu" %} (in table layout) or the {% octicon "kebab-horizontal" aria-label="the item menu" %} (in board layout), then select the desired action. diff --git a/content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md b/content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md index 07843a55d9..4b00391366 100644 --- a/content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md +++ b/content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md @@ -310,7 +310,7 @@ gh api graphql -f query=' ``` {% endcli %} -A project may contain items that a user does not have permission to view. In this case, the response will include redacted item. +A project may contain items that a user does not have permission to view. In this case, the response will include a redacted item. ```shell { @@ -373,7 +373,7 @@ The response will contain the node ID of the newly created item. } ``` -If you try add an item that already exists, the existing item ID is returned instead. +If you try to add an item that already exists, the existing item ID is returned instead. ### Updating a custom text, number, or date field diff --git a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md index a996ed33d9..d8e0ad69f7 100644 --- a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md @@ -37,6 +37,12 @@ All {% data variables.product.prodname_pages %} sites, including sites that are 3. Under "{% data variables.product.prodname_pages %}," select **Enforce HTTPS**. ![Enforce HTTPS checkbox](/assets/images/help/pages/enforce-https-checkbox.png) +## Troubleshooting certificate provisioning ("Certificate not yet created" error") + +When you set or change your custom domain in the Pages settings, an automatic DNS check begins. This check determines if your DNS settings are configured to allow {% data variables.product.prodname_dotcom %} to obtain a certificate automatically. If the check is successful, {% data variables.product.prodname_dotcom %} queues a job to request a TLS certificate from [Let's Encrypt](https://letsencrypt.org/). On receiving receiving a valid certificate, {% data variables.product.prodname_dotcom %} automatically uploads it to the servers that handle TLS termination for Pages. When this process completes successfully, a check mark is displayed beside your custom domain name. + +The process may take some time. If the process has not completed several minutes after you clicked **Save**, try clicking **Remove** next to your custom domain name. Retype the domain name and click **Save** again. This will cancel and restart the provisioning process. + ## Resolving problems with mixed content If you enable HTTPS for your {% data variables.product.prodname_pages %} site but your site's HTML still references images, CSS, or JavaScript over HTTP, then your site is serving *mixed content*. Serving mixed content may make your site less secure and cause trouble loading assets. diff --git a/data/reusables/actions/cd-templates-actions.md b/data/reusables/actions/cd-templates-actions.md index 8bc2c82226..7bc93daf9a 100644 --- a/data/reusables/actions/cd-templates-actions.md +++ b/data/reusables/actions/cd-templates-actions.md @@ -1,3 +1,3 @@ -{% data variables.product.product_name %} offers CD workflow templates for several popular services, such as Azure Web App. To learn how to get started using a workflow template, see "[Using workflow templates](/actions/learn-github-actions/using-workflow-templates)" or [browse the full list of deployment workflow templates](https://github.com/actions/starter-workflows/tree/main/deployments). You can also check out our more detailed guides for specific deployment workflows, such as "[Deploying to Azure App Service](/actions/deployment/deploying-to-azure-app-service)." +{% data variables.product.product_name %} offers CD starter workflow for several popular services, such as Azure Web App. To learn how to get started using a starter workflow, see "[Using starter workflows](/actions/learn-github-actions/using-starter-workflows)" or [browse the full list of deployment starter workflows](https://github.com/actions/starter-workflows/tree/main/deployments). You can also check out our more detailed guides for specific deployment workflows, such as "[Deploying to Azure App Service](/actions/deployment/deploying-to-azure-app-service)." Many service providers also offer actions on {% data variables.product.prodname_marketplace %} for deploying to their service. For the full list, see [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?category=deployment&type=actions). diff --git a/data/reusables/actions/workflow-organization-templates.md b/data/reusables/actions/workflow-organization-templates.md index c1a9412f34..0dc4dc05b0 100644 --- a/data/reusables/actions/workflow-organization-templates.md +++ b/data/reusables/actions/workflow-organization-templates.md @@ -1 +1 @@ -Workflow templates allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When you create a new workflow, you can choose a template and some or all of the work of writing the workflow will be done for you. You can use workflow templates as a starting place to build your custom workflow or use them as-is. This not only saves time, it promotes consistency and best practice across your organization. +Starter workflows allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When you create a new workflow, you can choose a starter workflow and some or all of the work of writing the workflow will be done for you. You can use starter workflows as a starting place to build your custom workflow or use them as-is. This not only saves time, it promotes consistency and best practice across your organization. diff --git a/data/reusables/actions/workflow-template-overview.md b/data/reusables/actions/workflow-template-overview.md index 88eff614a2..bf926adfc4 100644 --- a/data/reusables/actions/workflow-template-overview.md +++ b/data/reusables/actions/workflow-template-overview.md @@ -1,3 +1,3 @@ -{% data variables.product.prodname_dotcom %} provides preconfigured workflow templates that you can customize to create your own continuous integration workflow. {% data variables.product.product_name %} analyzes your code and shows you CI templates that might be useful for your repository. For example, if your repository contains Node.js code, you'll see suggestions for Node.js projects. You can use workflow templates as a starting place to build your custom workflow or use them as-is. +{% data variables.product.prodname_dotcom %} provides preconfigured starter workflow that you can customize to create your own continuous integration workflow. {% data variables.product.product_name %} analyzes your code and shows you CI starter workflow that might be useful for your repository. For example, if your repository contains Node.js code, you'll see suggestions for Node.js projects. You can use starter workflow as a starting place to build your custom workflow or use them as-is. -You can browse the full list of workflow templates in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}. +You can browse the full list of starter workflow in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}. diff --git a/data/reusables/github-actions/example-github-runner.md b/data/reusables/github-actions/example-github-runner.md index be49136efd..f4da555d66 100644 --- a/data/reusables/github-actions/example-github-runner.md +++ b/data/reusables/github-actions/example-github-runner.md @@ -1,6 +1,6 @@ ### Running on a different operating system -The starter workflow template configures jobs to run on Linux, using the {% data variables.product.prodname_dotcom %}-hosted `ubuntu-latest` runners. You can change the `runs-on` key to run your jobs on a different operating system. For example, you can use the {% data variables.product.prodname_dotcom %}-hosted Windows runners. +The starter workflow configures jobs to run on Linux, using the {% data variables.product.prodname_dotcom %}-hosted `ubuntu-latest` runners. You can change the `runs-on` key to run your jobs on a different operating system. For example, you can use the {% data variables.product.prodname_dotcom %}-hosted Windows runners. {% raw %} ```yaml diff --git a/data/reusables/github-actions/java-jvm-architecture.md b/data/reusables/github-actions/java-jvm-architecture.md index 2814ee964b..bffbb05631 100644 --- a/data/reusables/github-actions/java-jvm-architecture.md +++ b/data/reusables/github-actions/java-jvm-architecture.md @@ -1,6 +1,6 @@ ### Specifying the JVM version and architecture -The starter workflow template sets up the `PATH` to contain OpenJDK 8 for the x64 platform. If you want to use a different version of Java, or target a different architecture (`x64` or `x86`), you can use the `setup-java` action to choose a different Java runtime environment. +The starter workflow sets up the `PATH` to contain OpenJDK 8 for the x64 platform. If you want to use a different version of Java, or target a different architecture (`x64` or `x86`), you can use the `setup-java` action to choose a different Java runtime environment. For example, to use version 11 of the JDK provided by Adoptium for the x64 platform, you can use the `setup-java` action and configure the `java-version`, `distribution` and `architecture` parameters to `'11'`, `'adopt'` and `x64`. diff --git a/lib/search/indexes/github-docs-3.0-cn-records.json.br b/lib/search/indexes/github-docs-3.0-cn-records.json.br index 94b75820f0..c9361ef0c2 100644 --- a/lib/search/indexes/github-docs-3.0-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.0-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e3a20c5fd1858d5999f30ccc54525ae88ac4e7b816e09598203c69493e79213a -size 614798 +oid sha256:c45b5dd0cc71b1008eb4a8095d88680df328beb85b64ddef63992ded71cc82d7 +size 615474 diff --git a/lib/search/indexes/github-docs-3.0-cn.json.br b/lib/search/indexes/github-docs-3.0-cn.json.br index e6c3941711..975d48ccd3 100644 --- a/lib/search/indexes/github-docs-3.0-cn.json.br +++ b/lib/search/indexes/github-docs-3.0-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4f632e901251f20766898a4d5eb6e5a964b4cb51cbe1961e447a708c4fa32d0e -size 1749078 +oid sha256:1c0a1e1c8f09f6c03f5ecbed5a8221f320a7823ba8c25da0e80e75cc8ac63397 +size 1751683 diff --git a/lib/search/indexes/github-docs-3.0-en-records.json.br b/lib/search/indexes/github-docs-3.0-en-records.json.br index e099001f27..c4e31f2d30 100644 --- a/lib/search/indexes/github-docs-3.0-en-records.json.br +++ b/lib/search/indexes/github-docs-3.0-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:97d285582d76b5d8df78899589555d13e7dec96670cbb818341d11213f66d98e -size 952774 +oid sha256:bd178ebc0adeae783df0f2d75296a7ae0f07cc885a0c57ccd54147a91f74bd2a +size 952926 diff --git a/lib/search/indexes/github-docs-3.0-en.json.br b/lib/search/indexes/github-docs-3.0-en.json.br index 8a5bd7f2ca..404bd77966 100644 --- a/lib/search/indexes/github-docs-3.0-en.json.br +++ b/lib/search/indexes/github-docs-3.0-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:68d3e6eb07253612985752197cd3589eb0e12a43df0d1769d7dc73a46910c079 -size 3906161 +oid sha256:4495cd73cc0ead97b9a14e362154702b5bd84d378e02598e1b7cf05892173aaf +size 3906962 diff --git a/lib/search/indexes/github-docs-3.0-es-records.json.br b/lib/search/indexes/github-docs-3.0-es-records.json.br index c57845f398..aab83dcb63 100644 --- a/lib/search/indexes/github-docs-3.0-es-records.json.br +++ b/lib/search/indexes/github-docs-3.0-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2b74810306a26c8f6fff56092eec352ddad348a20d6ec465b9fe97ccff91ca35 -size 584202 +oid sha256:840ebd46f6e647efdbeb9b0fdc8246a232922f6aa7b47c13baecd63d1b4fe23a +size 584605 diff --git a/lib/search/indexes/github-docs-3.0-es.json.br b/lib/search/indexes/github-docs-3.0-es.json.br index 1947d3d87d..5734feacae 100644 --- a/lib/search/indexes/github-docs-3.0-es.json.br +++ b/lib/search/indexes/github-docs-3.0-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3b10c6d60d955516829fd6e04847775438c400e0ee6acda385ba713e2018deb2 -size 2703738 +oid sha256:88b4c3414f93d1fe9b21e63ed6ceccec3b7bc639a09f2109646a8d87353c89fd +size 2703155 diff --git a/lib/search/indexes/github-docs-3.0-ja-records.json.br b/lib/search/indexes/github-docs-3.0-ja-records.json.br index 45acf2d6d2..404f305ad1 100644 --- a/lib/search/indexes/github-docs-3.0-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.0-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9acc1e0cd18cddaef23e346c4dcbc676b7b3dda01dca3c420a0b08fa3ac18b35 -size 616524 +oid sha256:b53a068b8040866332a466e2fd1f6f250636e20cecf7ee0bff5961623e68f921 +size 618723 diff --git a/lib/search/indexes/github-docs-3.0-ja.json.br b/lib/search/indexes/github-docs-3.0-ja.json.br index 1500233d58..e482c724aa 100644 --- a/lib/search/indexes/github-docs-3.0-ja.json.br +++ b/lib/search/indexes/github-docs-3.0-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c5e91824b2d2460d0be45c32554f65e00d3672e183b6ef601c5ab433c3dac37b -size 3418240 +oid sha256:21e5cc4b33e5be40bfb9cc7bcb846d5b8cc16f9210766ac039d40c58c2187e4b +size 3476256 diff --git a/lib/search/indexes/github-docs-3.0-pt-records.json.br b/lib/search/indexes/github-docs-3.0-pt-records.json.br index d86be40337..227a9a7ce9 100644 --- a/lib/search/indexes/github-docs-3.0-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.0-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f610f6912c18df1f788272ccd6ed379a58930503657cb642a54f8a967f111658 -size 596260 +oid sha256:f24b3ca528d17890e1500dd60771c7fee1afeb942030d4d4a7a0b0fb09ac074f +size 596532 diff --git a/lib/search/indexes/github-docs-3.0-pt.json.br b/lib/search/indexes/github-docs-3.0-pt.json.br index 939e0eb0e2..d38323cb89 100644 --- a/lib/search/indexes/github-docs-3.0-pt.json.br +++ b/lib/search/indexes/github-docs-3.0-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2f8ad2446950fa2a179dcc0542f7da1c418abb907015fe9c473ef72d50f97592 -size 2808216 +oid sha256:cbc3ab95ea5cd4b62be8b9657966c51888ea645e0b1f8fb4c1d57517cf871dc9 +size 2811397 diff --git a/lib/search/indexes/github-docs-3.1-cn-records.json.br b/lib/search/indexes/github-docs-3.1-cn-records.json.br index 32f79922c2..259100876c 100644 --- a/lib/search/indexes/github-docs-3.1-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.1-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a1802f4dd8eef68364ec0a4c55e5c1a46593bfd31d776a95ed9b25c554113b35 -size 628172 +oid sha256:da668cfe259887b7af9ecea33e280db7e84dfdaf5ceda11fb53832a57414d81b +size 628876 diff --git a/lib/search/indexes/github-docs-3.1-cn.json.br b/lib/search/indexes/github-docs-3.1-cn.json.br index 294a25efc9..b176fc7e4e 100644 --- a/lib/search/indexes/github-docs-3.1-cn.json.br +++ b/lib/search/indexes/github-docs-3.1-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f122301ee06020f5235eb4021f01181b9e68af18021ff36f9f92f4f2e8e5ea56 -size 1790550 +oid sha256:1b9dc17d50a6f205391e1072b8ba3a193b49f405972f2f51909546e9b1944a95 +size 1792888 diff --git a/lib/search/indexes/github-docs-3.1-en-records.json.br b/lib/search/indexes/github-docs-3.1-en-records.json.br index 8739a1bd6f..60c48bc9a3 100644 --- a/lib/search/indexes/github-docs-3.1-en-records.json.br +++ b/lib/search/indexes/github-docs-3.1-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b667e38e7a2ebd28bdf0c07041b3b1a3d5334e21cc1b60b3bda6c399869187e3 -size 977419 +oid sha256:b1fc57998661b06f817e9df91015827c9c08438f3345080b9d4d8e00794e489f +size 977958 diff --git a/lib/search/indexes/github-docs-3.1-en.json.br b/lib/search/indexes/github-docs-3.1-en.json.br index d121814635..098419e1a4 100644 --- a/lib/search/indexes/github-docs-3.1-en.json.br +++ b/lib/search/indexes/github-docs-3.1-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a570677a93b7f067a8e3cea28c879319cecf561537b6052865c10e36683b6c8e -size 3996595 +oid sha256:9d3726307fe46c5239e3584c4c561d790ca05b417864ee7b8d4b1ab34c464fb1 +size 3997315 diff --git a/lib/search/indexes/github-docs-3.1-es-records.json.br b/lib/search/indexes/github-docs-3.1-es-records.json.br index 390ff37b6b..1cafd32d1c 100644 --- a/lib/search/indexes/github-docs-3.1-es-records.json.br +++ b/lib/search/indexes/github-docs-3.1-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6217cd9c14104ae2b1273f53d31d618ad68d61cb10b5235bac2543b50513ccd3 -size 596623 +oid sha256:a38e198dec7d9777e62f802309fe37784ab18e145e03832be5647e0ed5b1866a +size 596635 diff --git a/lib/search/indexes/github-docs-3.1-es.json.br b/lib/search/indexes/github-docs-3.1-es.json.br index 148f95d114..f4c4e20d58 100644 --- a/lib/search/indexes/github-docs-3.1-es.json.br +++ b/lib/search/indexes/github-docs-3.1-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0efcef59d8118170880c3b64486f9f59434d69ad6ac873227b840a28b132aaa1 -size 2766650 +oid sha256:5229af510d576887b3717267866f8fc2997a57513cd8c6b250c19cd4104b974d +size 2766737 diff --git a/lib/search/indexes/github-docs-3.1-ja-records.json.br b/lib/search/indexes/github-docs-3.1-ja-records.json.br index 8434716fc8..298ff9fbce 100644 --- a/lib/search/indexes/github-docs-3.1-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.1-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a150ba4f37875091f648d13ea86fa6113098517277892048d0dfe26ef787504a -size 630127 +oid sha256:dc034ea5e62ef6df29d9347e6a1495464cab5a6b8688ca465c2cb43107f68abd +size 632068 diff --git a/lib/search/indexes/github-docs-3.1-ja.json.br b/lib/search/indexes/github-docs-3.1-ja.json.br index 40bbe343d7..1499adef09 100644 --- a/lib/search/indexes/github-docs-3.1-ja.json.br +++ b/lib/search/indexes/github-docs-3.1-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:be94166b086e0ef3c1f40d0b23bc856f72b751a5b92e6f0767de8c0ce1541e33 -size 3496129 +oid sha256:23d6523b0738686505b761f13453d7767a77b4158f14155ba223fa24d86f0147 +size 3555138 diff --git a/lib/search/indexes/github-docs-3.1-pt-records.json.br b/lib/search/indexes/github-docs-3.1-pt-records.json.br index 78cff03218..6bf3a9a8e0 100644 --- a/lib/search/indexes/github-docs-3.1-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.1-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8c9b62a1a0dd86a3fb5903a79466a953f607950d02b68f0cc6cfa8a4a645ba36 -size 608534 +oid sha256:b59f762d340672990b340211dffcc699931544eee7fa1345c8a149758741d337 +size 608984 diff --git a/lib/search/indexes/github-docs-3.1-pt.json.br b/lib/search/indexes/github-docs-3.1-pt.json.br index ba0c538665..48710acc28 100644 --- a/lib/search/indexes/github-docs-3.1-pt.json.br +++ b/lib/search/indexes/github-docs-3.1-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6f0078d7c910a401bf28c07e9f561b3215f286132144de105f92245749812c5f -size 2870663 +oid sha256:c57bc3e8e9d50c9ba1a8a2e64b2e63c8a598e4082313508de1094f933b79ac68 +size 2875290 diff --git a/lib/search/indexes/github-docs-3.2-cn-records.json.br b/lib/search/indexes/github-docs-3.2-cn-records.json.br index ce479d0cdd..ed90bf6ee5 100644 --- a/lib/search/indexes/github-docs-3.2-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.2-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8914bad65a0b6c04ed75d4ecf436620546950579ab421ebdcbcc34a7fc671ae2 -size 639562 +oid sha256:0a882d77b62d642db501fe271772c56bea657adefc628dbcd5983f0d948488aa +size 640166 diff --git a/lib/search/indexes/github-docs-3.2-cn.json.br b/lib/search/indexes/github-docs-3.2-cn.json.br index fbd033e7e1..1966168b73 100644 --- a/lib/search/indexes/github-docs-3.2-cn.json.br +++ b/lib/search/indexes/github-docs-3.2-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e809dc05d28991d142c233a9e5a41773b4816bc96dacb0431a97c88e394d1fe7 -size 1817823 +oid sha256:d5e8697d95b61c12feec4fb6b47db17828097e427dae19f98a93efb9fae25c26 +size 1819679 diff --git a/lib/search/indexes/github-docs-3.2-en-records.json.br b/lib/search/indexes/github-docs-3.2-en-records.json.br index 6caf2e66fe..f35faa3d3b 100644 --- a/lib/search/indexes/github-docs-3.2-en-records.json.br +++ b/lib/search/indexes/github-docs-3.2-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:60fde470d3ae7d4647601f2ab78af52ab65246b5e7946221025ae776578f3e96 -size 1012514 +oid sha256:745fa8d2473cc9fb39ef398b0168decaef47571fdcc35d9cb70f3d65545e3bf6 +size 1008925 diff --git a/lib/search/indexes/github-docs-3.2-en.json.br b/lib/search/indexes/github-docs-3.2-en.json.br index a165279fee..7d21a93472 100644 --- a/lib/search/indexes/github-docs-3.2-en.json.br +++ b/lib/search/indexes/github-docs-3.2-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d279182990ad8080aee62d9df692e4781bc1c81dec3f451a594e942f3c4f8e66 -size 4120413 +oid sha256:6e4b777715092d7d35ace264b14a5fc254ad43969d8402e543e38f55bcf3bab3 +size 4120222 diff --git a/lib/search/indexes/github-docs-3.2-es-records.json.br b/lib/search/indexes/github-docs-3.2-es-records.json.br index 94647191c5..1cf3166291 100644 --- a/lib/search/indexes/github-docs-3.2-es-records.json.br +++ b/lib/search/indexes/github-docs-3.2-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:de0fcf5e05c0f66c5c7b86de4013c7fee0ac0115ea0df05deb4d10528a798ba4 -size 606994 +oid sha256:c66b9ef8ffd1117af2378add9dfa2f5fc751dfa307ce075122c89e26fd8db9ee +size 607090 diff --git a/lib/search/indexes/github-docs-3.2-es.json.br b/lib/search/indexes/github-docs-3.2-es.json.br index 1342ed08bd..cfda76f3ea 100644 --- a/lib/search/indexes/github-docs-3.2-es.json.br +++ b/lib/search/indexes/github-docs-3.2-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:acf61ba473de78aeb276ada3dd2c878863055bb12eb9263cf31632659d11a345 -size 2821057 +oid sha256:73dad5abe189260649e97a27aae869a1f3ff8d37d55fa160cffe565166a6c9b0 +size 2821599 diff --git a/lib/search/indexes/github-docs-3.2-ja-records.json.br b/lib/search/indexes/github-docs-3.2-ja-records.json.br index ecc2902220..26aa0869bf 100644 --- a/lib/search/indexes/github-docs-3.2-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.2-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:98f0f7c20e86628270c9fcb72a925f2a40938ab5d5de4601621cf9935d159ed9 -size 641610 +oid sha256:c89ebdfef90b9747ed76d88a526f71126f833768289c66d9fd23e8ad2edfa92f +size 643544 diff --git a/lib/search/indexes/github-docs-3.2-ja.json.br b/lib/search/indexes/github-docs-3.2-ja.json.br index 9f154dbdcd..41de86525c 100644 --- a/lib/search/indexes/github-docs-3.2-ja.json.br +++ b/lib/search/indexes/github-docs-3.2-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c444e281f717b7216499637cff56068f4adaa2b16a49cd7e106007e3e0e707ed -size 3562901 +oid sha256:e335d9bbc5cc236a13159e6b05a4fcf891801fcad7258f9932f3050c0b220fbd +size 3622460 diff --git a/lib/search/indexes/github-docs-3.2-pt-records.json.br b/lib/search/indexes/github-docs-3.2-pt-records.json.br index 31b744694c..6cf9d561cb 100644 --- a/lib/search/indexes/github-docs-3.2-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.2-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:73ca24c21e8f7ca928787dae41c86f4b7e86c6f9123156f890244cbbb9235937 -size 619768 +oid sha256:8b1c9a3fce256cbba714806bdffb05c9b2cf5567eff6ecc97e2814c59c6365cd +size 620319 diff --git a/lib/search/indexes/github-docs-3.2-pt.json.br b/lib/search/indexes/github-docs-3.2-pt.json.br index c3315d9093..c49b61b97f 100644 --- a/lib/search/indexes/github-docs-3.2-pt.json.br +++ b/lib/search/indexes/github-docs-3.2-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:705259f1354a6457d22a4e42b6b559db57c14c1dffcf01eb9aa2fc4f4f953636 -size 2919993 +oid sha256:fc8d57e72e1c4b835fa4163a2ae8fb30ad0d5780bd9a306f124a09a809de6e17 +size 2924448 diff --git a/lib/search/indexes/github-docs-3.3-cn-records.json.br b/lib/search/indexes/github-docs-3.3-cn-records.json.br index 24421ed641..d4d3e49bf8 100644 --- a/lib/search/indexes/github-docs-3.3-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.3-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e434d0541d0517a314e2c856a6b841ea40d1b8451748cacaa49b91ad0f9279d4 -size 659926 +oid sha256:cce3cb66fce26748cef0bc020746a51186e748e62807f9d51b52cf211a4047e7 +size 660673 diff --git a/lib/search/indexes/github-docs-3.3-cn.json.br b/lib/search/indexes/github-docs-3.3-cn.json.br index 7fb7cec83c..f23d283c8c 100644 --- a/lib/search/indexes/github-docs-3.3-cn.json.br +++ b/lib/search/indexes/github-docs-3.3-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2d99f6ba692c07145b63239d9951c11e35aae552319fd07ab2b2f1abaac571b1 -size 1875074 +oid sha256:1ed968e480f885c77d1f62fb35cbe6ae50317e0e59bb26d09aa425d158741a69 +size 1876950 diff --git a/lib/search/indexes/github-docs-3.3-en-records.json.br b/lib/search/indexes/github-docs-3.3-en-records.json.br index d1bfbdc18a..1c22d3a6ee 100644 --- a/lib/search/indexes/github-docs-3.3-en-records.json.br +++ b/lib/search/indexes/github-docs-3.3-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7f3dd4c310c0fec30c5fbd1ee026c44e2593481e6785684073f93440474f9004 -size 1042137 +oid sha256:c216bad4df15954a7b719ae6a84a0141c3ed7ad5cdb142d6292cabd2d8414857 +size 1043131 diff --git a/lib/search/indexes/github-docs-3.3-en.json.br b/lib/search/indexes/github-docs-3.3-en.json.br index 87ec1d9107..5100df7fff 100644 --- a/lib/search/indexes/github-docs-3.3-en.json.br +++ b/lib/search/indexes/github-docs-3.3-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8f2574fe386ffca461e9edcce066f09b281d1c38721589733420e5a111b7f77f -size 4220461 +oid sha256:febf26f7686cc5678a77c8a0ea8fab942e29a9033563aa3db9c3b96748989f37 +size 4222148 diff --git a/lib/search/indexes/github-docs-3.3-es-records.json.br b/lib/search/indexes/github-docs-3.3-es-records.json.br index 5719fec684..8e89d43e5e 100644 --- a/lib/search/indexes/github-docs-3.3-es-records.json.br +++ b/lib/search/indexes/github-docs-3.3-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ddc5be4def84376ca65ec7eeb3630e1c2f78e1c0b493c66876039ced521e95b7 -size 624909 +oid sha256:d543eb98245d449a2417a1b950529d13d50d00708f15ef398eadab945c36bdeb +size 625366 diff --git a/lib/search/indexes/github-docs-3.3-es.json.br b/lib/search/indexes/github-docs-3.3-es.json.br index 55241efe99..b7c9920bce 100644 --- a/lib/search/indexes/github-docs-3.3-es.json.br +++ b/lib/search/indexes/github-docs-3.3-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:35ad6c7c8c2a31a43b442e05498f913e45dd42ff46e06d824ac58993534733e1 -size 2918696 +oid sha256:7c3c4abaa7ee7df30b8cd4e78b58caf3118b4344f92206e386784bc061afe9ba +size 2919324 diff --git a/lib/search/indexes/github-docs-3.3-ja-records.json.br b/lib/search/indexes/github-docs-3.3-ja-records.json.br index 090da8d6bc..1e2a1e907b 100644 --- a/lib/search/indexes/github-docs-3.3-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.3-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8412a5f1c2f679cd6f04e74e3315bf493f1b1d5dd4da8c9de8ff77a877713181 -size 662866 +oid sha256:8fcf38a2e8f6a9440d4c3c8de7597a78af54357ef30e4db77ece4bcc1e523785 +size 665156 diff --git a/lib/search/indexes/github-docs-3.3-ja.json.br b/lib/search/indexes/github-docs-3.3-ja.json.br index 64388d15d7..4066eae9e7 100644 --- a/lib/search/indexes/github-docs-3.3-ja.json.br +++ b/lib/search/indexes/github-docs-3.3-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f4c3531d75c240140e2116c998671877a1a3029a5154c56f823b5ae7d4ed3807 -size 3682928 +oid sha256:2c9555d8c33308e0542edd6a37300418e9f12f2ff8bdd8dc469b03e81413c0b5 +size 3739528 diff --git a/lib/search/indexes/github-docs-3.3-pt-records.json.br b/lib/search/indexes/github-docs-3.3-pt-records.json.br index c16059b43c..1153bc95ce 100644 --- a/lib/search/indexes/github-docs-3.3-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.3-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:07edb3654f7d5b7b28cf7a6ca4c9803f6070c70d8dc7a6846c32e2d63d540e25 -size 638882 +oid sha256:a6bbdbf2ff6025b8dd7e860310df22afcda1e24f1c4cc814e000ba4a9e33348c +size 639455 diff --git a/lib/search/indexes/github-docs-3.3-pt.json.br b/lib/search/indexes/github-docs-3.3-pt.json.br index 36230659f4..ccf78c4102 100644 --- a/lib/search/indexes/github-docs-3.3-pt.json.br +++ b/lib/search/indexes/github-docs-3.3-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:82cec6243af164b19ca8dd50f914aaa078b9d7cabc227b7c902c6a9885e6281a -size 3006226 +oid sha256:75924965aad8bc776233fdc002823b33c4195034beea6386185deb604f1a5e93 +size 3011478 diff --git a/lib/search/indexes/github-docs-dotcom-cn-records.json.br b/lib/search/indexes/github-docs-dotcom-cn-records.json.br index beef9ccb7f..cdcfd75e6b 100644 --- a/lib/search/indexes/github-docs-dotcom-cn-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:44073bb0acb676a4ebaab470cfc075a03682e15b3d2a51b2438be12144524791 -size 848926 +oid sha256:f545b67edd8edc2af12ae311bca11e42152c4d54dac6a3e443eb5b50eac83e8a +size 849430 diff --git a/lib/search/indexes/github-docs-dotcom-cn.json.br b/lib/search/indexes/github-docs-dotcom-cn.json.br index e773ed8df6..920af7769e 100644 --- a/lib/search/indexes/github-docs-dotcom-cn.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cabefda1724695fcc4ea02173e1bcaa21c943568e94465bebc73b51114b4853d -size 2094810 +oid sha256:8e93ca342828d286ddd8067eddb5cf2a8f5037f6b3e1284b9f7f33c667bd0c2d +size 2097488 diff --git a/lib/search/indexes/github-docs-dotcom-en-records.json.br b/lib/search/indexes/github-docs-dotcom-en-records.json.br index 8353ba81c4..b913b1064c 100644 --- a/lib/search/indexes/github-docs-dotcom-en-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6f16bbb2041242080f71596eca79df57f70fc195924cdc6042bcc8005f4040f4 -size 1319080 +oid sha256:e5f9e022bc3cbabf01bf2a18166d3d0eb1a8c18b14ef665bdc204d4921f2c7f1 +size 1326513 diff --git a/lib/search/indexes/github-docs-dotcom-en.json.br b/lib/search/indexes/github-docs-dotcom-en.json.br index b45e584ef5..2bfe4f6a9b 100644 --- a/lib/search/indexes/github-docs-dotcom-en.json.br +++ b/lib/search/indexes/github-docs-dotcom-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:95aaaf63ff9dc64c380c879d551a621eaee4bdf0922da76d52c03f87c789d27b -size 5063047 +oid sha256:4f23788b4c8533d25be65a2bcd9a3f3de4ec45942b1dce3e4998595bc9a8ee0e +size 5066816 diff --git a/lib/search/indexes/github-docs-dotcom-es-records.json.br b/lib/search/indexes/github-docs-dotcom-es-records.json.br index 316af9546b..c01e8f9573 100644 --- a/lib/search/indexes/github-docs-dotcom-es-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4e7ae567f068064cfa4a8b5759fb1241df90c14b77aa3fb697e2d62c9da4f1ee -size 795869 +oid sha256:3f2756bb3ca8b5f709102386c47d6532faf40d4f4c8024541393ac029b352e62 +size 795812 diff --git a/lib/search/indexes/github-docs-dotcom-es.json.br b/lib/search/indexes/github-docs-dotcom-es.json.br index b44d400647..3941078291 100644 --- a/lib/search/indexes/github-docs-dotcom-es.json.br +++ b/lib/search/indexes/github-docs-dotcom-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1f858190082ecd4274de63069e02fcfe4c95eae5455e8bec3031a2addeed03fc -size 3504802 +oid sha256:e95eeebeb5261355c32f6a985e1fd921decaa2975ba4f03756eb98b650f33b60 +size 3503520 diff --git a/lib/search/indexes/github-docs-dotcom-ja-records.json.br b/lib/search/indexes/github-docs-dotcom-ja-records.json.br index 5ac39aede9..8235ce72c0 100644 --- a/lib/search/indexes/github-docs-dotcom-ja-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d40168446b82d488936b5c5fe5d1c1d43a0ac5d1c0883e67dd369c43f62faa8c -size 858621 +oid sha256:d93c6ad1b3b02db08daa6fefd5edf251b494ed77c57a392f7f7995c905a957cb +size 857724 diff --git a/lib/search/indexes/github-docs-dotcom-ja.json.br b/lib/search/indexes/github-docs-dotcom-ja.json.br index 85229ccc21..0a47473bd7 100644 --- a/lib/search/indexes/github-docs-dotcom-ja.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cee36e373b945b1f7937e15b3cddcd4260a34164990ebe6eb098e0d2958e03ce -size 4500670 +oid sha256:f03f7baa2540fe727a177ae6a207fb33be4549110ed9ce6f723767820a8e3c40 +size 4558989 diff --git a/lib/search/indexes/github-docs-dotcom-pt-records.json.br b/lib/search/indexes/github-docs-dotcom-pt-records.json.br index 0494279d0a..dc83d8cb9c 100644 --- a/lib/search/indexes/github-docs-dotcom-pt-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2afc54e31f90b7f9df214d8cd52c578a7b274e19216a5d62f99c8fa3bff89446 -size 810255 +oid sha256:10eb00d5b6f2afc8ee883893cc6b827673d6fe966e73fe2f287cf46448a9efcc +size 810676 diff --git a/lib/search/indexes/github-docs-dotcom-pt.json.br b/lib/search/indexes/github-docs-dotcom-pt.json.br index 836cfa5c1d..f04d34bf3a 100644 --- a/lib/search/indexes/github-docs-dotcom-pt.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ce3549ae04ecc2fd2ba010fa808564a7b429103b7d9cb3e4a366d9434562daa4 -size 3593307 +oid sha256:bc8edb1d49109e969de6afa51faecfa7645692557130bb5e5df523020765b580 +size 3599393 diff --git a/lib/search/indexes/github-docs-ghae-cn-records.json.br b/lib/search/indexes/github-docs-ghae-cn-records.json.br index f9548acb8d..1e5ebf038b 100644 --- a/lib/search/indexes/github-docs-ghae-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghae-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:67c7538de8cfde28868587a5579400ec7366b826a798b81911a5c4750cb5fc6b -size 513678 +oid sha256:5117fbcc79e8c50ffc50a0b6b953b75ef2fd40b40cae11b09b6ab32e0e5488dc +size 514242 diff --git a/lib/search/indexes/github-docs-ghae-cn.json.br b/lib/search/indexes/github-docs-ghae-cn.json.br index 6ecc102a12..a641f55f6b 100644 --- a/lib/search/indexes/github-docs-ghae-cn.json.br +++ b/lib/search/indexes/github-docs-ghae-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aed114fb3e64ebf92e1be2e603dc0915fd218d360fe758f4ef41e5f3d2f8b668 -size 1418372 +oid sha256:8a370e43527f8b0dd318941bcd4868244f6805eb2b9cbfa04af1d974a4c2f47b +size 1420382 diff --git a/lib/search/indexes/github-docs-ghae-en-records.json.br b/lib/search/indexes/github-docs-ghae-en-records.json.br index e87ee45fe9..ceaf2065bd 100644 --- a/lib/search/indexes/github-docs-ghae-en-records.json.br +++ b/lib/search/indexes/github-docs-ghae-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bc6c2bf23ac44b2f0a3882f8809a208ba65524448ceadc67d0a86fc740410d44 -size 831471 +oid sha256:01e24534ca659d39691bdc94682fe0e3fdebf74dcea4b04541dc236d114813b7 +size 831549 diff --git a/lib/search/indexes/github-docs-ghae-en.json.br b/lib/search/indexes/github-docs-ghae-en.json.br index 928685ade6..8b2b3ec67c 100644 --- a/lib/search/indexes/github-docs-ghae-en.json.br +++ b/lib/search/indexes/github-docs-ghae-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f9a10d72357b098b68cccb77dc9647a66a4bd60f8e11fdf9ecfc792abd50e706 -size 3337426 +oid sha256:c810adfb9eaa1543e65057be4ec1398c7d1ec2150b9ab542c23ffbb65f57565a +size 3338257 diff --git a/lib/search/indexes/github-docs-ghae-es-records.json.br b/lib/search/indexes/github-docs-ghae-es-records.json.br index 79f5a2b739..da96a02bac 100644 --- a/lib/search/indexes/github-docs-ghae-es-records.json.br +++ b/lib/search/indexes/github-docs-ghae-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ff1bafa464c506aae2f4910722145ff1bc5eb68eab2d694561c0648f481f1471 -size 487967 +oid sha256:e3351c8e9749580049ed507751db432309602e9cb8219193e32f7456736a4a32 +size 488081 diff --git a/lib/search/indexes/github-docs-ghae-es.json.br b/lib/search/indexes/github-docs-ghae-es.json.br index cf6ee5435f..522365349e 100644 --- a/lib/search/indexes/github-docs-ghae-es.json.br +++ b/lib/search/indexes/github-docs-ghae-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0f12beaa9d5351ea4d5a607e86fd986b6419376d9f2f74830dd6456b1d574ccf -size 2196147 +oid sha256:245947cb6b51ddb04d1f5490543a1a3f4db0428be177d603d9d24a76a122609e +size 2195968 diff --git a/lib/search/indexes/github-docs-ghae-ja-records.json.br b/lib/search/indexes/github-docs-ghae-ja-records.json.br index 9cdfb7d495..a1b028f666 100644 --- a/lib/search/indexes/github-docs-ghae-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghae-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:086362e6fb4ab64bff7f0f1e0351188349afc476168c4eaa5a237d2172f99b85 -size 515449 +oid sha256:f9e6a4fc9763aa45e254b6c2706c21cb52d486a1e93c223e204113f9bbe2c4d9 +size 517244 diff --git a/lib/search/indexes/github-docs-ghae-ja.json.br b/lib/search/indexes/github-docs-ghae-ja.json.br index c2eed2cdfc..7ca0e8c03c 100644 --- a/lib/search/indexes/github-docs-ghae-ja.json.br +++ b/lib/search/indexes/github-docs-ghae-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2205b00d90eaddacc41738dc1ff29fb176c019e1f28673ea796cd05e77c6f94a -size 2747018 +oid sha256:d0d06c9a34ed047586afcbc3d1991ec62e274cca9bc496dc63190d52cd0c2233 +size 2802247 diff --git a/lib/search/indexes/github-docs-ghae-pt-records.json.br b/lib/search/indexes/github-docs-ghae-pt-records.json.br index 19fa00a959..1260499a6c 100644 --- a/lib/search/indexes/github-docs-ghae-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghae-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:98edfb0bc15b56a860c858b76343ff262e76be94f14726c44bd9e1e730648a0a -size 500244 +oid sha256:9ee90809e0f85d69faa5184d2be465912fa2253fb88475d01677181171c7c32c +size 500718 diff --git a/lib/search/indexes/github-docs-ghae-pt.json.br b/lib/search/indexes/github-docs-ghae-pt.json.br index 3d838bc968..6908866cc5 100644 --- a/lib/search/indexes/github-docs-ghae-pt.json.br +++ b/lib/search/indexes/github-docs-ghae-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d9f7df5013ee6def077c74f5794c83d69acb594374a2a8b3d65151b271dcef1b -size 2276899 +oid sha256:172c3b44ad07d7932e596cc002ebe6c7bffdfbfb3124d4602ec7ee4febe1fedf +size 2280887 diff --git a/lib/search/indexes/github-docs-ghec-cn-records.json.br b/lib/search/indexes/github-docs-ghec-cn-records.json.br index 0b5a8b76f8..ad7c33967b 100644 --- a/lib/search/indexes/github-docs-ghec-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghec-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ebfe55942d201604560aa966159dbde724323ceacf7da1f12502e66d143a1955 -size 772757 +oid sha256:3476c9e1de9956fb6cbbc487829c766ee39c1a2cf745fcd800d0d8eed6154f23 +size 773627 diff --git a/lib/search/indexes/github-docs-ghec-cn.json.br b/lib/search/indexes/github-docs-ghec-cn.json.br index 1afee517ee..395722ba3f 100644 --- a/lib/search/indexes/github-docs-ghec-cn.json.br +++ b/lib/search/indexes/github-docs-ghec-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6bbbb2458a214731609f9284fedb0ff3ee51bcd444ebcd5878c672ee4dc6b66c -size 2112578 +oid sha256:536a3399cff30b77c6271b92c21fe882a894a85a5f03fc93fb6d18f643aa1f93 +size 2116047 diff --git a/lib/search/indexes/github-docs-ghec-en-records.json.br b/lib/search/indexes/github-docs-ghec-en-records.json.br index 94f1ecc12c..757d1e0d90 100644 --- a/lib/search/indexes/github-docs-ghec-en-records.json.br +++ b/lib/search/indexes/github-docs-ghec-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:90e546fcf8564899a4ffae0e18ea6d280b8337bad4a1ca49e8aabbd0a75685dc -size 1187114 +oid sha256:9f0b6dbd695324e1a37373b9d8c600c114abab0b1dc29fbc1e09a767dae9d805 +size 1187842 diff --git a/lib/search/indexes/github-docs-ghec-en.json.br b/lib/search/indexes/github-docs-ghec-en.json.br index aac2c1e74e..96930382ab 100644 --- a/lib/search/indexes/github-docs-ghec-en.json.br +++ b/lib/search/indexes/github-docs-ghec-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c6fdb56059c44cef8bbc236c90d61b001f31e4493f685e1ca511c817ff3647ff -size 4792857 +oid sha256:d37633f9555ce290cc7ab112a4517989d01ab9c26ddea4d847c6a586b8423a5c +size 4793594 diff --git a/lib/search/indexes/github-docs-ghec-es-records.json.br b/lib/search/indexes/github-docs-ghec-es-records.json.br index e6f7164587..c7f34aa890 100644 --- a/lib/search/indexes/github-docs-ghec-es-records.json.br +++ b/lib/search/indexes/github-docs-ghec-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:26a5249e37255e1077b4752fd7b7a16961ec064341371735a4afd783fc5fe216 -size 740518 +oid sha256:cea70cbb37c96669e8287d80a380258a368a4ac2cc12d1aa638b8a10ee99a153 +size 740413 diff --git a/lib/search/indexes/github-docs-ghec-es.json.br b/lib/search/indexes/github-docs-ghec-es.json.br index 7be6753106..f839be614e 100644 --- a/lib/search/indexes/github-docs-ghec-es.json.br +++ b/lib/search/indexes/github-docs-ghec-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:609a3da1abc76611fd0d62c97b059f35095a68d2c7940f940cdad8b1f7610921 -size 3448385 +oid sha256:58f44df8eea0c534ba9d755c00f6bc88d294831f446775cd80e1b8c6d3fb5557 +size 3447880 diff --git a/lib/search/indexes/github-docs-ghec-ja-records.json.br b/lib/search/indexes/github-docs-ghec-ja-records.json.br index 8fab1345e9..81968c5cd3 100644 --- a/lib/search/indexes/github-docs-ghec-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghec-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a138334543cc1ae3c79f3033fd9e0bc4487d1807d9cc464f41a76a619238ac6c -size 785162 +oid sha256:f49e1e3d3cc1b832260ce968162b47804f91adc8c96740601047789c3dc126dc +size 783791 diff --git a/lib/search/indexes/github-docs-ghec-ja.json.br b/lib/search/indexes/github-docs-ghec-ja.json.br index 9f9e0352ad..b8390d4408 100644 --- a/lib/search/indexes/github-docs-ghec-ja.json.br +++ b/lib/search/indexes/github-docs-ghec-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ebe93f61d0478208e9743a57dbd48e3526517391ba56fff644eee9ba983ee634 -size 4340751 +oid sha256:70b68e69696da52c5e8a013d7ea097ab15aa5ed8d6d73506efe39cf3e1221e67 +size 4398284 diff --git a/lib/search/indexes/github-docs-ghec-pt-records.json.br b/lib/search/indexes/github-docs-ghec-pt-records.json.br index 74fae75c11..b06c682b65 100644 --- a/lib/search/indexes/github-docs-ghec-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghec-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:eba3cf71aced32c4e9e1cd457ba7574395f7b8dc72c626313221fa9de20a2935 -size 754695 +oid sha256:4d7c210f7a5845575e6da2ba6579296ef254305950fab00f31009e3951af2a50 +size 755238 diff --git a/lib/search/indexes/github-docs-ghec-pt.json.br b/lib/search/indexes/github-docs-ghec-pt.json.br index 603878669e..f77b92e95b 100644 --- a/lib/search/indexes/github-docs-ghec-pt.json.br +++ b/lib/search/indexes/github-docs-ghec-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9a1e19ba58de89b9cd714ad46ac05359326deff0ff769b7207aedbad47706f9a -size 3529160 +oid sha256:bbec231dfc15ceab9ee4635ab7a763d7c7ec6f1f9d64aa324239f41c059fb1f9 +size 3534586 diff --git a/translations/es-ES/content/actions/learn-github-actions/creating-workflow-templates.md b/translations/es-ES/content/actions/learn-github-actions/creating-workflow-templates.md deleted file mode 100644 index 3ad83990c7..0000000000 --- a/translations/es-ES/content/actions/learn-github-actions/creating-workflow-templates.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Creating workflow templates -shortTitle: Creating templates -intro: Learn how you can create workflow templates to help people in your team add new workflows more easily. -redirect_from: - - /actions/configuring-and-managing-workflows/sharing-workflow-templates-within-your-organization -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## Overview - -{% data reusables.actions.workflow-organization-templates %} - -## Creating a workflow template - -Workflow templates can be created by users with write access to the organization's `.github` repository. The templates can then be used by organization members who have permission to create workflows. - -{% ifversion fpt %} -Your workflow templates can be used to create workflows in public repositories only. Organizations using {% data variables.product.prodname_ghe_cloud %} can also use workflow templates to create workflows in private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/learn-github-actions/creating-workflow-templates). -{% endif %} - -{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -{% note %} - -**Note:** To avoid duplication in workflows created from a template you can call reusable workflows from within a workflow template. This can help make your workflows easier to maintain. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." - -{% endnote %} -{% endif %} - -This procedure demonstrates how to create a workflow template and metadata file. The metadata file describes how the template is presented to users when they are creating a new workflow. - -1. If it doesn't already exist, create a new public repository named `.github` in your organization. -2. Create a directory named `workflow-templates`. -3. Create your new workflow file inside the `workflow-templates` directory. - - If you need to refer to a repository's default branch, you can use the `$default-branch` placeholder. When a workflow is created using your template, the placeholder will be automatically replaced with the name of the repository's default branch. - - For example, this file named `octo-organization-ci.yml` demonstrates a basic workflow. - - ```yaml - name: Octo Organization CI - - on: - push: - branches: [ $default-branch ] - pull_request: - branches: [ $default-branch ] - - jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - - name: Run a one-line script - run: echo Hello from Octo Organization - ``` -4. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: - ```yaml - { - "name": "Octo Organization Workflow", - "description": "Octo Organization CI workflow template.", - "iconName": "example-icon", - "categories": [ - "Go" - ], - "filePatterns": [ - "package.json$", - "^Dockerfile", - ".*\\.md$" - ] - } - ``` - * `name` - **Required.** The name of the workflow template. This is displayed in the list of available templates. - * `description` - **Required.** The description of the workflow template. This is displayed in the list of available templates. - * `iconName` - **Optional.** Defines an icon for the workflow's entry in the template list. The `iconName` must be an SVG icon of the same name, and must be stored in the `workflow-templates` directory. For example, a SVG file named `example-icon.svg` is referenced as `example-icon`. - * `categories` - **Optional.** Defines the language category of the workflow. When a user views the available templates, those templates that match the same language will feature more prominently. For information on the available language categories, see https://github.com/github/linguist/blob/master/lib/linguist/languages.yml. - * `filePatterns` - **Optional.** Allows the template to be used if the user's repository has a file in its root directory that matches a defined regular expression. - -To add another workflow template, add your files to the same `workflow-templates` directory. For example: - -![Workflow template files](/assets/images/help/images/workflow-template-files.png) - -## Next steps - -To continue learning about {% data variables.product.prodname_actions %}, see "[Using workflow templates](/actions/learn-github-actions/using-workflow-templates)." diff --git a/translations/es-ES/content/actions/learn-github-actions/using-workflow-templates.md b/translations/es-ES/content/actions/learn-github-actions/using-workflow-templates.md deleted file mode 100644 index 8bdb52e763..0000000000 --- a/translations/es-ES/content/actions/learn-github-actions/using-workflow-templates.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Using workflow templates -shortTitle: Using templates -intro: '{% data variables.product.product_name %} provides workflow templates for a variety of languages and tooling.' -redirect_from: - - /articles/setting-up-continuous-integration-using-github-actions - - /github/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/building-and-testing-code-with-continuous-integration/setting-up-continuous-integration-using-github-actions - - /actions/guides/setting-up-continuous-integration-using-workflow-templates -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI - - CD ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## About workflow templates - -{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests. - -You can also create your own workflow templates to share with your organization. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." - -## Using workflow templates - -Anyone with write permission to a repository can set up {% data variables.product.prodname_actions %} workflows for CI/CD or other automation. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.actions-tab %} -1. If you already have a workflow in your repository, click **New workflow**. -1. Find the template that you want to use, then click **Set up this workflow**. -1. If the workflow template contains comments detailing additional setup steps, follow these steps. -1. Some workflow templates use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." -1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs. -1. Click **Start commit**. -1. Write a commit message and decide whether to commit directly to the default branch or to open a pull request. - -## Further reading - -- "[About continuous integration](/articles/about-continuous-integration)" -- "[Managing workflow runs](/actions/managing-workflow-runs)" -- "[About monitoring and troubleshooting](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)" -- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" -{% ifversion fpt or ghec %} -- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" -{% endif %} diff --git a/translations/ja-JP/content/actions/learn-github-actions/creating-workflow-templates.md b/translations/ja-JP/content/actions/learn-github-actions/creating-workflow-templates.md deleted file mode 100644 index 3ad83990c7..0000000000 --- a/translations/ja-JP/content/actions/learn-github-actions/creating-workflow-templates.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Creating workflow templates -shortTitle: Creating templates -intro: Learn how you can create workflow templates to help people in your team add new workflows more easily. -redirect_from: - - /actions/configuring-and-managing-workflows/sharing-workflow-templates-within-your-organization -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## Overview - -{% data reusables.actions.workflow-organization-templates %} - -## Creating a workflow template - -Workflow templates can be created by users with write access to the organization's `.github` repository. The templates can then be used by organization members who have permission to create workflows. - -{% ifversion fpt %} -Your workflow templates can be used to create workflows in public repositories only. Organizations using {% data variables.product.prodname_ghe_cloud %} can also use workflow templates to create workflows in private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/learn-github-actions/creating-workflow-templates). -{% endif %} - -{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -{% note %} - -**Note:** To avoid duplication in workflows created from a template you can call reusable workflows from within a workflow template. This can help make your workflows easier to maintain. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." - -{% endnote %} -{% endif %} - -This procedure demonstrates how to create a workflow template and metadata file. The metadata file describes how the template is presented to users when they are creating a new workflow. - -1. If it doesn't already exist, create a new public repository named `.github` in your organization. -2. Create a directory named `workflow-templates`. -3. Create your new workflow file inside the `workflow-templates` directory. - - If you need to refer to a repository's default branch, you can use the `$default-branch` placeholder. When a workflow is created using your template, the placeholder will be automatically replaced with the name of the repository's default branch. - - For example, this file named `octo-organization-ci.yml` demonstrates a basic workflow. - - ```yaml - name: Octo Organization CI - - on: - push: - branches: [ $default-branch ] - pull_request: - branches: [ $default-branch ] - - jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - - name: Run a one-line script - run: echo Hello from Octo Organization - ``` -4. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: - ```yaml - { - "name": "Octo Organization Workflow", - "description": "Octo Organization CI workflow template.", - "iconName": "example-icon", - "categories": [ - "Go" - ], - "filePatterns": [ - "package.json$", - "^Dockerfile", - ".*\\.md$" - ] - } - ``` - * `name` - **Required.** The name of the workflow template. This is displayed in the list of available templates. - * `description` - **Required.** The description of the workflow template. This is displayed in the list of available templates. - * `iconName` - **Optional.** Defines an icon for the workflow's entry in the template list. The `iconName` must be an SVG icon of the same name, and must be stored in the `workflow-templates` directory. For example, a SVG file named `example-icon.svg` is referenced as `example-icon`. - * `categories` - **Optional.** Defines the language category of the workflow. When a user views the available templates, those templates that match the same language will feature more prominently. For information on the available language categories, see https://github.com/github/linguist/blob/master/lib/linguist/languages.yml. - * `filePatterns` - **Optional.** Allows the template to be used if the user's repository has a file in its root directory that matches a defined regular expression. - -To add another workflow template, add your files to the same `workflow-templates` directory. For example: - -![Workflow template files](/assets/images/help/images/workflow-template-files.png) - -## Next steps - -To continue learning about {% data variables.product.prodname_actions %}, see "[Using workflow templates](/actions/learn-github-actions/using-workflow-templates)." diff --git a/translations/ja-JP/content/actions/learn-github-actions/using-workflow-templates.md b/translations/ja-JP/content/actions/learn-github-actions/using-workflow-templates.md deleted file mode 100644 index f7685fa3f0..0000000000 --- a/translations/ja-JP/content/actions/learn-github-actions/using-workflow-templates.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Using workflow templates -shortTitle: Using templates -intro: '{% data variables.product.product_name %} provides workflow templates for a variety of languages and tooling.' -redirect_from: - - /articles/setting-up-continuous-integration-using-github-actions - - /github/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/building-and-testing-code-with-continuous-integration/setting-up-continuous-integration-using-github-actions - - /actions/guides/setting-up-continuous-integration-using-workflow-templates -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI - - CD ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## About workflow templates - -{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant workflow templates.{% endif %} - -You can also create your own workflow templates to share with your organization. These templates will appear alongside the {% data variables.product.product_name %} workflow templates. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." - -## Using workflow templates - -Anyone with write permission to a repository can set up {% data variables.product.prodname_actions %} workflows for CI/CD or other automation. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.actions-tab %} -1. If you already have a workflow in your repository, click **New workflow**. -1. Find the template that you want to use, then click **Set up this workflow**.{% if actions-starter-template-ui %} To help you find the template that you want, you can search for keywords or filter by category.{% endif %} -1. If the workflow template contains comments detailing additional setup steps, follow these steps. Many of the templates have corresponding guides. For more information, see [the {% data variables.product.prodname_actions %} guides](/actions/guides)." -1. Some workflow templates use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." -1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs. -1. Click **Start commit**. -1. Write a commit message and decide whether to commit directly to the default branch or to open a pull request. - -## Further reading - -- "[About continuous integration](/articles/about-continuous-integration)" -- "[Managing workflow runs](/actions/managing-workflow-runs)" -- "[About monitoring and troubleshooting](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)" -- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" -{% ifversion fpt or ghec %} -- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" -{% endif %} diff --git a/translations/ja-JP/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md b/translations/ja-JP/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md index b3c1173329..20a2edd4b6 100644 --- a/translations/ja-JP/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md +++ b/translations/ja-JP/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md @@ -45,7 +45,7 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l issues: write{% endif %} steps: - name: Label issues - uses: andymckay/labeler@5c59dabdfd4dd5bd9c6e6d255b01b9d764af4414 + uses: andymckay/labeler@e6c4322d0397f3240f0e7e30a33b5c5df2d39e90 with: add-labels: "triage" repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 88ca60761c..2122636727 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -161,6 +161,13 @@ This workflow scans: If your code requires a specific operating system to compile, you can configure the operating system in your {% data variables.product.prodname_codeql_workflow %}. Edit the value of `jobs.analyze.runs-on` to specify the operating system for the machine that runs your {% data variables.product.prodname_code_scanning %} actions. {% ifversion ghes %}You specify the operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% else %} +``` yaml +jobs: + analyze: + name: Analyze + runs-on: [ubuntu-latest] +``` + If you choose to use a self-hosted runner for code scanning, you can specify an operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% endif %} ``` yaml @@ -170,12 +177,14 @@ jobs: runs-on: [self-hosted, ubuntu-latest] ``` -{% ifversion fpt or ghec %}For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."{% endif %} - {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} supports the latest versions of Ubuntu, Windows, and macOS. Typical values for this setting are therefore: `ubuntu-latest`, `windows-latest`, and `macos-latest`. For more information, see {% ifversion ghes %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)" and "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners){% else %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on){% endif %}." {% ifversion ghes %}You must ensure that Git is in the PATH variable on your self-hosted runners.{% else %}If you use a self-hosted runner, you must ensure that Git is in the PATH variable.{% endif %} +For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + +For recommended specifications (RAM, CPU cores, and disk) for running {% data variables.product.prodname_codeql %} analysis{% ifversion not ghes %} on self-hosted machines{% endif %}, see "[Recommended hardware resources for running {% data variables.product.prodname_codeql %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql)." + {% ifversion fpt or ghes > 3.1 or ghae or ghec %} ## Specifying the location for {% data variables.product.prodname_codeql %} databases diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md index 4f9478f221..622a6eb37f 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md @@ -22,6 +22,7 @@ children: - /tracking-code-scanning-alerts-in-issues-using-task-lists - /configuring-code-scanning - /about-code-scanning-with-codeql + - /recommended-hardware-resources-for-running-codeql - /configuring-the-codeql-workflow-for-compiled-languages - /troubleshooting-the-codeql-workflow - /running-codeql-code-scanning-in-a-container diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql.md new file mode 100644 index 0000000000..4ea514673d --- /dev/null +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql.md @@ -0,0 +1,32 @@ +--- +title: Recommended hardware resources for running CodeQL +shortTitle: Hardware resources for CodeQL +intro: 'Recommended specifications (RAM, CPU cores, and disk) for running {% data variables.product.prodname_codeql %} analysis on self-hosted machines, based on the size of your codebase.' +product: '{% data reusables.gated-features.code-scanning %}' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Integration + - CI + +--- +You can set up {% data variables.product.prodname_codeql %} on {% data variables.product.prodname_actions %} or on an external CI system. {% data variables.product.prodname_codeql %} is fully compatible with {% data variables.product.prodname_dotcom %}-hosted runners on {% data variables.product.prodname_actions %}. + +If you're using an external CI system, or self-hosted runners on {% data variables.product.prodname_actions %} for private repositories, you're responsible for configuring your own hardware. The optimal hardware configuration for running {% data variables.product.prodname_codeql %} may vary based on the size and complexity of your codebase, the programming languages and build systems being used, and your CI workflow setup. + +The table below provides recommended hardware specifications for running {% data variables.product.prodname_codeql %} analysis, based on the size of your codebase. Use these as a starting point for determining your choice of hardware or virtual machine. A machine with greater resources may improve analysis performance, but may also be more expensive to maintain. + +| Codebase size | RAM | CPU | +|--------|--------|--------| +| Small (<100 K lines of code) | 8 GB or higher | 2 cores | +| Medium (100 K to 1 M lines of code) | 16 GB or higher | 4 or 8 cores | +| Large (>1 M lines of code) | 64 GB or higher | 8 cores | + +For all codebase sizes, we recommend using an SSD with 14 GB or more of disk space. There must be enough disk space to check out and build your code, plus additional space for data produced by {% data variables.product.prodname_codeql %}. diff --git a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md index 1099495b71..8528c045c6 100644 --- a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md +++ b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md @@ -28,7 +28,7 @@ redirect_from: ## About using the {% data variables.product.prodname_codeql_cli %} for {% data variables.product.prodname_code_scanning %} -You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." +You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." For recommended specifications (RAM, CPU cores, and disk) for running {% data variables.product.prodname_codeql %} analysis, see "[Recommended hardware resources for running {% data variables.product.prodname_codeql %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql)." {% data reusables.code-scanning.what-is-codeql-cli %} diff --git a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md index f6f88a8066..c2c3020329 100644 --- a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md +++ b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md @@ -39,6 +39,8 @@ A typical workflow that uses the {% data variables.product.prodname_codeql_cli % - `codeql database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. This command must be run once for each language or database. - `codeql github upload-results` to upload the resulting SARIF files to {% data variables.product.prodname_dotcom %}, to be displayed as code scanning alerts. This command must be run once for each language or SARIF file. +The {% data variables.product.prodname_codeql_runner %} is multithreaded by default. The {% data variables.product.prodname_codeql_cli %} only uses a single thread by default, but allows you to specify the amount of threads you want it to use. If you want to replicate the behavior of the {% data variables.product.prodname_codeql_runner %} to use all threads available on the machine when using the {% data variables.product.prodname_codeql_cli %}, you can pass `--threads 0` to `codeql database analyze`. + For more information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)." ## Examples of common uses for the {% data variables.product.prodname_codeql_cli %} diff --git a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md index 820352f6af..7fd44389ce 100644 --- a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md +++ b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md @@ -1,7 +1,7 @@ --- title: Renaming a branch intro: You can change the name of a branch in a repository. -permissions: People with write permissions to a repository can rename a branch in the repository. People with admin permissions can rename the default branch. +permissions: 'People with write permissions to a repository can rename a branch in the repository unless it is the [default branch](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch){% ifversion fpt or ghec %} or a [protected branch](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches){% endif %}. People with admin permissions can rename the default branch{% ifversion fpt or ghec %} and protected branches{% endif %}.' versions: fpt: '*' ghes: '>=3.1' diff --git a/translations/ja-JP/content/search-github/searching-on-github/searching-commits.md b/translations/ja-JP/content/search-github/searching-on-github/searching-commits.md index e7f31a7604..e0e772a5f7 100644 --- a/translations/ja-JP/content/search-github/searching-on-github/searching-commits.md +++ b/translations/ja-JP/content/search-github/searching-on-github/searching-commits.md @@ -109,11 +109,9 @@ The `is` qualifier matches commits from repositories with the specified visibili {%- ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories. {%- endif %} - {%- ifversion ghes or ghec or ghae %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) matches commits to internal repositories. {%- endif %} - | `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches commits to private repositories. ## Further reading diff --git a/translations/log/cn-resets.csv b/translations/log/cn-resets.csv index 6b8e2855b6..d58b3bbe01 100644 --- a/translations/log/cn-resets.csv +++ b/translations/log/cn-resets.csv @@ -400,6 +400,7 @@ translations/zh-CN/content/code-security/code-scanning/automatically-scanning-yo translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md,rendering error translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md,rendering error translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,rendering error +translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql.md,rendering error translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md,rendering error translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,parsing error translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md,rendering error @@ -429,7 +430,6 @@ translations/zh-CN/content/code-security/supply-chain-security/keeping-your-depe translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md,rendering error translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,Listed in localization-support#489 translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,parsing error -translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,rendering error translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md,rendering error translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md,rendering error translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md,rendering error diff --git a/translations/log/ja-resets.csv b/translations/log/ja-resets.csv index 84ac5ae748..5f2dc19e63 100644 --- a/translations/log/ja-resets.csv +++ b/translations/log/ja-resets.csv @@ -414,6 +414,7 @@ translations/ja-JP/content/code-security/code-scanning/automatically-scanning-yo translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,rendering error +translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,rendering error translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md,rendering error diff --git a/translations/pt-BR/content/actions/learn-github-actions/creating-workflow-templates.md b/translations/pt-BR/content/actions/learn-github-actions/creating-workflow-templates.md deleted file mode 100644 index 3ad83990c7..0000000000 --- a/translations/pt-BR/content/actions/learn-github-actions/creating-workflow-templates.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Creating workflow templates -shortTitle: Creating templates -intro: Learn how you can create workflow templates to help people in your team add new workflows more easily. -redirect_from: - - /actions/configuring-and-managing-workflows/sharing-workflow-templates-within-your-organization -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## Overview - -{% data reusables.actions.workflow-organization-templates %} - -## Creating a workflow template - -Workflow templates can be created by users with write access to the organization's `.github` repository. The templates can then be used by organization members who have permission to create workflows. - -{% ifversion fpt %} -Your workflow templates can be used to create workflows in public repositories only. Organizations using {% data variables.product.prodname_ghe_cloud %} can also use workflow templates to create workflows in private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/learn-github-actions/creating-workflow-templates). -{% endif %} - -{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -{% note %} - -**Note:** To avoid duplication in workflows created from a template you can call reusable workflows from within a workflow template. This can help make your workflows easier to maintain. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." - -{% endnote %} -{% endif %} - -This procedure demonstrates how to create a workflow template and metadata file. The metadata file describes how the template is presented to users when they are creating a new workflow. - -1. If it doesn't already exist, create a new public repository named `.github` in your organization. -2. Create a directory named `workflow-templates`. -3. Create your new workflow file inside the `workflow-templates` directory. - - If you need to refer to a repository's default branch, you can use the `$default-branch` placeholder. When a workflow is created using your template, the placeholder will be automatically replaced with the name of the repository's default branch. - - For example, this file named `octo-organization-ci.yml` demonstrates a basic workflow. - - ```yaml - name: Octo Organization CI - - on: - push: - branches: [ $default-branch ] - pull_request: - branches: [ $default-branch ] - - jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - - name: Run a one-line script - run: echo Hello from Octo Organization - ``` -4. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: - ```yaml - { - "name": "Octo Organization Workflow", - "description": "Octo Organization CI workflow template.", - "iconName": "example-icon", - "categories": [ - "Go" - ], - "filePatterns": [ - "package.json$", - "^Dockerfile", - ".*\\.md$" - ] - } - ``` - * `name` - **Required.** The name of the workflow template. This is displayed in the list of available templates. - * `description` - **Required.** The description of the workflow template. This is displayed in the list of available templates. - * `iconName` - **Optional.** Defines an icon for the workflow's entry in the template list. The `iconName` must be an SVG icon of the same name, and must be stored in the `workflow-templates` directory. For example, a SVG file named `example-icon.svg` is referenced as `example-icon`. - * `categories` - **Optional.** Defines the language category of the workflow. When a user views the available templates, those templates that match the same language will feature more prominently. For information on the available language categories, see https://github.com/github/linguist/blob/master/lib/linguist/languages.yml. - * `filePatterns` - **Optional.** Allows the template to be used if the user's repository has a file in its root directory that matches a defined regular expression. - -To add another workflow template, add your files to the same `workflow-templates` directory. For example: - -![Workflow template files](/assets/images/help/images/workflow-template-files.png) - -## Next steps - -To continue learning about {% data variables.product.prodname_actions %}, see "[Using workflow templates](/actions/learn-github-actions/using-workflow-templates)." diff --git a/translations/pt-BR/content/actions/learn-github-actions/using-workflow-templates.md b/translations/pt-BR/content/actions/learn-github-actions/using-workflow-templates.md deleted file mode 100644 index f7685fa3f0..0000000000 --- a/translations/pt-BR/content/actions/learn-github-actions/using-workflow-templates.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Using workflow templates -shortTitle: Using templates -intro: '{% data variables.product.product_name %} provides workflow templates for a variety of languages and tooling.' -redirect_from: - - /articles/setting-up-continuous-integration-using-github-actions - - /github/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/building-and-testing-code-with-continuous-integration/setting-up-continuous-integration-using-github-actions - - /actions/guides/setting-up-continuous-integration-using-workflow-templates -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI - - CD ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## About workflow templates - -{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant workflow templates.{% endif %} - -You can also create your own workflow templates to share with your organization. These templates will appear alongside the {% data variables.product.product_name %} workflow templates. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." - -## Using workflow templates - -Anyone with write permission to a repository can set up {% data variables.product.prodname_actions %} workflows for CI/CD or other automation. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.actions-tab %} -1. If you already have a workflow in your repository, click **New workflow**. -1. Find the template that you want to use, then click **Set up this workflow**.{% if actions-starter-template-ui %} To help you find the template that you want, you can search for keywords or filter by category.{% endif %} -1. If the workflow template contains comments detailing additional setup steps, follow these steps. Many of the templates have corresponding guides. For more information, see [the {% data variables.product.prodname_actions %} guides](/actions/guides)." -1. Some workflow templates use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." -1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs. -1. Click **Start commit**. -1. Write a commit message and decide whether to commit directly to the default branch or to open a pull request. - -## Further reading - -- "[About continuous integration](/articles/about-continuous-integration)" -- "[Managing workflow runs](/actions/managing-workflow-runs)" -- "[About monitoring and troubleshooting](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)" -- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" -{% ifversion fpt or ghec %} -- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" -{% endif %} diff --git a/translations/zh-CN/content/actions/learn-github-actions/creating-workflow-templates.md b/translations/zh-CN/content/actions/learn-github-actions/creating-workflow-templates.md deleted file mode 100644 index 3ad83990c7..0000000000 --- a/translations/zh-CN/content/actions/learn-github-actions/creating-workflow-templates.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Creating workflow templates -shortTitle: Creating templates -intro: Learn how you can create workflow templates to help people in your team add new workflows more easily. -redirect_from: - - /actions/configuring-and-managing-workflows/sharing-workflow-templates-within-your-organization -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## Overview - -{% data reusables.actions.workflow-organization-templates %} - -## Creating a workflow template - -Workflow templates can be created by users with write access to the organization's `.github` repository. The templates can then be used by organization members who have permission to create workflows. - -{% ifversion fpt %} -Your workflow templates can be used to create workflows in public repositories only. Organizations using {% data variables.product.prodname_ghe_cloud %} can also use workflow templates to create workflows in private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/learn-github-actions/creating-workflow-templates). -{% endif %} - -{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -{% note %} - -**Note:** To avoid duplication in workflows created from a template you can call reusable workflows from within a workflow template. This can help make your workflows easier to maintain. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)." - -{% endnote %} -{% endif %} - -This procedure demonstrates how to create a workflow template and metadata file. The metadata file describes how the template is presented to users when they are creating a new workflow. - -1. If it doesn't already exist, create a new public repository named `.github` in your organization. -2. Create a directory named `workflow-templates`. -3. Create your new workflow file inside the `workflow-templates` directory. - - If you need to refer to a repository's default branch, you can use the `$default-branch` placeholder. When a workflow is created using your template, the placeholder will be automatically replaced with the name of the repository's default branch. - - For example, this file named `octo-organization-ci.yml` demonstrates a basic workflow. - - ```yaml - name: Octo Organization CI - - on: - push: - branches: [ $default-branch ] - pull_request: - branches: [ $default-branch ] - - jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - - name: Run a one-line script - run: echo Hello from Octo Organization - ``` -4. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: - ```yaml - { - "name": "Octo Organization Workflow", - "description": "Octo Organization CI workflow template.", - "iconName": "example-icon", - "categories": [ - "Go" - ], - "filePatterns": [ - "package.json$", - "^Dockerfile", - ".*\\.md$" - ] - } - ``` - * `name` - **Required.** The name of the workflow template. This is displayed in the list of available templates. - * `description` - **Required.** The description of the workflow template. This is displayed in the list of available templates. - * `iconName` - **Optional.** Defines an icon for the workflow's entry in the template list. The `iconName` must be an SVG icon of the same name, and must be stored in the `workflow-templates` directory. For example, a SVG file named `example-icon.svg` is referenced as `example-icon`. - * `categories` - **Optional.** Defines the language category of the workflow. When a user views the available templates, those templates that match the same language will feature more prominently. For information on the available language categories, see https://github.com/github/linguist/blob/master/lib/linguist/languages.yml. - * `filePatterns` - **Optional.** Allows the template to be used if the user's repository has a file in its root directory that matches a defined regular expression. - -To add another workflow template, add your files to the same `workflow-templates` directory. For example: - -![Workflow template files](/assets/images/help/images/workflow-template-files.png) - -## Next steps - -To continue learning about {% data variables.product.prodname_actions %}, see "[Using workflow templates](/actions/learn-github-actions/using-workflow-templates)." diff --git a/translations/zh-CN/content/actions/learn-github-actions/using-workflow-templates.md b/translations/zh-CN/content/actions/learn-github-actions/using-workflow-templates.md deleted file mode 100644 index f7685fa3f0..0000000000 --- a/translations/zh-CN/content/actions/learn-github-actions/using-workflow-templates.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Using workflow templates -shortTitle: Using templates -intro: '{% data variables.product.product_name %} provides workflow templates for a variety of languages and tooling.' -redirect_from: - - /articles/setting-up-continuous-integration-using-github-actions - - /github/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/automating-your-workflow-with-github-actions/setting-up-continuous-integration-using-github-actions - - /actions/building-and-testing-code-with-continuous-integration/setting-up-continuous-integration-using-github-actions - - /actions/guides/setting-up-continuous-integration-using-workflow-templates -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: tutorial -topics: - - Workflows - - CI - - CD ---- - -{% data reusables.actions.enterprise-beta %} -{% data reusables.actions.enterprise-github-hosted-runners %} - -## About workflow templates - -{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant workflow templates.{% endif %} - -You can also create your own workflow templates to share with your organization. These templates will appear alongside the {% data variables.product.product_name %} workflow templates. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)." - -## Using workflow templates - -Anyone with write permission to a repository can set up {% data variables.product.prodname_actions %} workflows for CI/CD or other automation. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.actions-tab %} -1. If you already have a workflow in your repository, click **New workflow**. -1. Find the template that you want to use, then click **Set up this workflow**.{% if actions-starter-template-ui %} To help you find the template that you want, you can search for keywords or filter by category.{% endif %} -1. If the workflow template contains comments detailing additional setup steps, follow these steps. Many of the templates have corresponding guides. For more information, see [the {% data variables.product.prodname_actions %} guides](/actions/guides)." -1. Some workflow templates use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." -1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs. -1. Click **Start commit**. -1. Write a commit message and decide whether to commit directly to the default branch or to open a pull request. - -## Further reading - -- "[About continuous integration](/articles/about-continuous-integration)" -- "[Managing workflow runs](/actions/managing-workflow-runs)" -- "[About monitoring and troubleshooting](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)" -- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" -{% ifversion fpt or ghec %} -- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)" -{% endif %} diff --git a/translations/zh-CN/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md b/translations/zh-CN/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md index b3c1173329..20a2edd4b6 100644 --- a/translations/zh-CN/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md +++ b/translations/zh-CN/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md @@ -45,7 +45,7 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l issues: write{% endif %} steps: - name: Label issues - uses: andymckay/labeler@5c59dabdfd4dd5bd9c6e6d255b01b9d764af4414 + uses: andymckay/labeler@e6c4322d0397f3240f0e7e30a33b5c5df2d39e90 with: add-labels: "triage" repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 88ca60761c..2122636727 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -161,6 +161,13 @@ This workflow scans: If your code requires a specific operating system to compile, you can configure the operating system in your {% data variables.product.prodname_codeql_workflow %}. Edit the value of `jobs.analyze.runs-on` to specify the operating system for the machine that runs your {% data variables.product.prodname_code_scanning %} actions. {% ifversion ghes %}You specify the operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% else %} +``` yaml +jobs: + analyze: + name: Analyze + runs-on: [ubuntu-latest] +``` + If you choose to use a self-hosted runner for code scanning, you can specify an operating system by using an appropriate label as the second element in a two-element array, after `self-hosted`.{% endif %} ``` yaml @@ -170,12 +177,14 @@ jobs: runs-on: [self-hosted, ubuntu-latest] ``` -{% ifversion fpt or ghec %}For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."{% endif %} - {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} supports the latest versions of Ubuntu, Windows, and macOS. Typical values for this setting are therefore: `ubuntu-latest`, `windows-latest`, and `macos-latest`. For more information, see {% ifversion ghes %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#self-hosted-runners)" and "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners){% else %}"[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on){% endif %}." {% ifversion ghes %}You must ensure that Git is in the PATH variable on your self-hosted runners.{% else %}If you use a self-hosted runner, you must ensure that Git is in the PATH variable.{% endif %} +For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + +For recommended specifications (RAM, CPU cores, and disk) for running {% data variables.product.prodname_codeql %} analysis{% ifversion not ghes %} on self-hosted machines{% endif %}, see "[Recommended hardware resources for running {% data variables.product.prodname_codeql %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql)." + {% ifversion fpt or ghes > 3.1 or ghae or ghec %} ## Specifying the location for {% data variables.product.prodname_codeql %} databases diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md index 4f9478f221..622a6eb37f 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md @@ -22,6 +22,7 @@ children: - /tracking-code-scanning-alerts-in-issues-using-task-lists - /configuring-code-scanning - /about-code-scanning-with-codeql + - /recommended-hardware-resources-for-running-codeql - /configuring-the-codeql-workflow-for-compiled-languages - /troubleshooting-the-codeql-workflow - /running-codeql-code-scanning-in-a-container diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql.md new file mode 100644 index 0000000000..4ea514673d --- /dev/null +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql.md @@ -0,0 +1,32 @@ +--- +title: Recommended hardware resources for running CodeQL +shortTitle: Hardware resources for CodeQL +intro: 'Recommended specifications (RAM, CPU cores, and disk) for running {% data variables.product.prodname_codeql %} analysis on self-hosted machines, based on the size of your codebase.' +product: '{% data reusables.gated-features.code-scanning %}' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Integration + - CI + +--- +You can set up {% data variables.product.prodname_codeql %} on {% data variables.product.prodname_actions %} or on an external CI system. {% data variables.product.prodname_codeql %} is fully compatible with {% data variables.product.prodname_dotcom %}-hosted runners on {% data variables.product.prodname_actions %}. + +If you're using an external CI system, or self-hosted runners on {% data variables.product.prodname_actions %} for private repositories, you're responsible for configuring your own hardware. The optimal hardware configuration for running {% data variables.product.prodname_codeql %} may vary based on the size and complexity of your codebase, the programming languages and build systems being used, and your CI workflow setup. + +The table below provides recommended hardware specifications for running {% data variables.product.prodname_codeql %} analysis, based on the size of your codebase. Use these as a starting point for determining your choice of hardware or virtual machine. A machine with greater resources may improve analysis performance, but may also be more expensive to maintain. + +| Codebase size | RAM | CPU | +|--------|--------|--------| +| Small (<100 K lines of code) | 8 GB or higher | 2 cores | +| Medium (100 K to 1 M lines of code) | 16 GB or higher | 4 or 8 cores | +| Large (>1 M lines of code) | 64 GB or higher | 8 cores | + +For all codebase sizes, we recommend using an SSD with 14 GB or more of disk space. There must be enough disk space to check out and build your code, plus additional space for data produced by {% data variables.product.prodname_codeql %}. diff --git a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md index 1099495b71..8528c045c6 100644 --- a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md +++ b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md @@ -28,7 +28,7 @@ redirect_from: ## About using the {% data variables.product.prodname_codeql_cli %} for {% data variables.product.prodname_code_scanning %} -You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." +You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)." For recommended specifications (RAM, CPU cores, and disk) for running {% data variables.product.prodname_codeql %} analysis, see "[Recommended hardware resources for running {% data variables.product.prodname_codeql %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql)." {% data reusables.code-scanning.what-is-codeql-cli %} diff --git a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md index f6f88a8066..c2c3020329 100644 --- a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md +++ b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md @@ -39,6 +39,8 @@ A typical workflow that uses the {% data variables.product.prodname_codeql_cli % - `codeql database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. This command must be run once for each language or database. - `codeql github upload-results` to upload the resulting SARIF files to {% data variables.product.prodname_dotcom %}, to be displayed as code scanning alerts. This command must be run once for each language or SARIF file. +The {% data variables.product.prodname_codeql_runner %} is multithreaded by default. The {% data variables.product.prodname_codeql_cli %} only uses a single thread by default, but allows you to specify the amount of threads you want it to use. If you want to replicate the behavior of the {% data variables.product.prodname_codeql_runner %} to use all threads available on the machine when using the {% data variables.product.prodname_codeql_cli %}, you can pass `--threads 0` to `codeql database analyze`. + For more information, see "[Configuring {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system)." ## Examples of common uses for the {% data variables.product.prodname_codeql_cli %} diff --git a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md index 820352f6af..7fd44389ce 100644 --- a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md +++ b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md @@ -1,7 +1,7 @@ --- title: Renaming a branch intro: You can change the name of a branch in a repository. -permissions: People with write permissions to a repository can rename a branch in the repository. People with admin permissions can rename the default branch. +permissions: 'People with write permissions to a repository can rename a branch in the repository unless it is the [default branch](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch){% ifversion fpt or ghec %} or a [protected branch](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches){% endif %}. People with admin permissions can rename the default branch{% ifversion fpt or ghec %} and protected branches{% endif %}.' versions: fpt: '*' ghes: '>=3.1' diff --git a/translations/zh-CN/content/search-github/searching-on-github/searching-commits.md b/translations/zh-CN/content/search-github/searching-on-github/searching-commits.md index e7f31a7604..e0e772a5f7 100644 --- a/translations/zh-CN/content/search-github/searching-on-github/searching-commits.md +++ b/translations/zh-CN/content/search-github/searching-on-github/searching-commits.md @@ -109,11 +109,9 @@ The `is` qualifier matches commits from repositories with the specified visibili {%- ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories. {%- endif %} - {%- ifversion ghes or ghec or ghae %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) matches commits to internal repositories. {%- endif %} - | `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches commits to private repositories. ## Further reading