Skip to content

Commit

Permalink
Merge pull request github#34318 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Aug 15, 2024
2 parents 805a698 + 65de3e2 commit 1a924d0
Show file tree
Hide file tree
Showing 72 changed files with 253 additions and 201 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can configure your CD workflow to run when a {% data variables.product.produ

{% data reusables.actions.about-oidc-short-overview %}

## Starter workflows and third party actions
## Workflow templates and third party actions

{% data reusables.actions.cd-templates-actions %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,17 @@ 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 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.
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 workflow template 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 workflow template, or create your own custom workflow file to run your CI tests.

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 "[AUTOTITLE](/actions/learn-github-actions)."

For a definition of common terms, see "[AUTOTITLE](/actions/learn-github-actions/understanding-github-actions)."

## Starter workflows
## Workflow templates

{% data variables.product.product_name %} offers CI starter workflows for a variety of languages and frameworks.
{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks.

Browse the complete list of CI starter workflows 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.location.product_location %}{% endif %}.
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.location.product_location %}{% endif %}.

## Further reading

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Sharing workflows, secrets, and runners with your organization'
shortTitle: Share workflows with your organization
intro: 'Learn how you can use organization features to collaborate with your team, by sharing starter workflows, secrets, variables, and self-hosted runners.'
intro: 'Learn how you can use organization features to collaborate with your team, by sharing workflow templates, secrets, variables, and self-hosted runners.'
redirect_from:
- /actions/learn-github-actions/sharing-workflows-with-your-organization
- /actions/learn-github-actions/sharing-workflows-secrets-and-runners-with-your-organization
Expand All @@ -17,14 +17,14 @@ 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 starter workflows 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 workflow templates in the `.github` repository and share them with other users in your organization.

## Sharing {% ifversion internal-actions %}actions and {% endif %}workflows

{% ifversion internal-actions %}
You can share both individual actions and entire workflows with your organization, with or without publishing the actions or workflows publicly. You can reuse actions and workflows exactly by referencing them in your workflow file, and you can create starter workflows that provide templates for new workflows.
You can share both individual actions and entire workflows with your organization, with or without publishing the actions or workflows publicly. You can reuse actions and workflows exactly by referencing them in your workflow file, and you can create workflow templates.
{% else %}
Your organization can share workflows by reusing the workflows exactly or by creating starter workflows that provide templates for new workflows.
Your organization can share workflows by reusing the workflows exactly or by creating workflow templates
{% endif %}

{% ifversion internal-actions %}
Expand All @@ -38,7 +38,7 @@ Your organization can share workflows by reusing the workflows exactly or by cre

{% data reusables.actions.reusable-workflows %}

### Using starter workflows
### Using workflow templates

{% data reusables.actions.workflow-organization-templates %} For more information, see "[AUTOTITLE](/actions/using-workflows/creating-starter-workflows-for-your-organization)."

Expand Down
2 changes: 1 addition & 1 deletion content/actions/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ includeGuides:
- /actions/writing-workflows/quickstart
- /actions/about-github-actions/understanding-github-actions
- /actions/sharing-automations/creating-actions/creating-a-docker-container-action
- /actions/writing-workflows/using-starter-workflows
- /actions/writing-workflows/using-workflow-templates
- /actions/use-cases-and-examples/building-and-testing/building-and-testing-python
- /actions/use-cases-and-examples/building-and-testing/building-and-testing-nodejs
- /actions/use-cases-and-examples/publishing-packages/about-packaging-with-github-actions
Expand Down
2 changes: 1 addition & 1 deletion content/actions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ featuredLinks:
- /actions/use-cases-and-examples/publishing-packages/about-packaging-with-github-actions
- /actions/monitoring-and-troubleshooting-workflows
guideCards:
- /actions/writing-workflows/using-starter-workflows
- /actions/writing-workflows/using-workflow-templates
- /actions/use-cases-and-examples/publishing-packages/publishing-nodejs-packages
- /actions/use-cases-and-examples/building-and-testing/building-and-testing-powershell
popular:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,10 +152,10 @@ With this approach, the value of the {% raw %}`${{ github.event.issue.title }}`{

{% ifversion fpt or ghec %}

### Using starter workflows for {% data variables.product.prodname_code_scanning %}
### Using workflow templates for {% data variables.product.prodname_code_scanning %}

{% data reusables.advanced-security.starter-workflows-beta %}
{% data variables.product.prodname_code_scanning_caps %} allows you to find security vulnerabilities before they reach production. {% data variables.product.product_name %} provides starter workflows for {% data variables.product.prodname_code_scanning %}. You can use these suggested workflows to construct your {% data variables.product.prodname_code_scanning %} workflows, instead of starting from scratch. {% data variables.product.company_short%}'s workflow, the {% data variables.code-scanning.codeql_workflow %}, is powered by {% data variables.product.prodname_codeql %}. There are also third-party starter workflows available.
{% data variables.product.prodname_code_scanning_caps %} allows you to find security vulnerabilities before they reach production. {% data variables.product.product_name %} provides workflow templates for {% data variables.product.prodname_code_scanning %}. You can use these suggested workflows to construct your {% data variables.product.prodname_code_scanning %} workflows, instead of starting from scratch. {% data variables.product.company_short%}'s workflow, the {% data variables.code-scanning.codeql_workflow %}, is powered by {% data variables.product.prodname_codeql %}. There are also third-party workflow templates available.

For more information, see "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning)" and "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-code-scanning-using-third-party-actions)."

Expand Down Expand Up @@ -229,7 +229,7 @@ For more information on how to configure this setting, see {% ifversion ghes or

## Using OpenSSF Scorecards to secure workflows

[Scorecards](https://github.com/ossf/scorecard) is an automated security tool that flags risky supply chain practices. You can use the [Scorecards action](https://github.com/marketplace/actions/ossf-scorecard-action) and [starter workflow](https://github.com/actions/starter-workflows) to follow best security practices. Once configured, the Scorecards action runs automatically on repository changes, and alerts developers about risky supply chain practices using the built-in {% data variables.product.prodname_code_scanning %} experience. The Scorecards project runs a number of checks, including script injection attacks, token permissions, and pinned actions.
[Scorecards](https://github.com/ossf/scorecard) is an automated security tool that flags risky supply chain practices. You can use the [Scorecards action](https://github.com/marketplace/actions/ossf-scorecard-action) and [workflow template](https://github.com/actions/starter-workflows) to follow best security practices. Once configured, the Scorecards action runs automatically on repository changes, and alerts developers about risky supply chain practices using the built-in {% data variables.product.prodname_code_scanning %} experience. The Scorecards project runs a number of checks, including script injection attacks, token permissions, and pinned actions.

## Potential impact of a compromised runner

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ topics:

{% data reusables.actions.workflow-organization-templates %}

{% data reusables.actions.starter-workflow-categories %}
{% data reusables.actions.workflow-templates-categories %}

> [!NOTE]
> Because workflow templates require a public `.github` repository, they are not available for {% data variables.product.prodname_emus %}.
Expand Down Expand Up @@ -88,7 +88,7 @@ This procedure demonstrates how to create a workflow template and metadata file.
```json copy
{
"name": "Octo Organization Workflow",
"description": "Octo Organization CI starter workflow.",
"description": "Octo Organization CI workflow template.",
"iconName": "example-icon",
"categories": [
"Go"
Expand All @@ -113,7 +113,7 @@ This procedure demonstrates how to create a workflow template and metadata file.

* `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.
To add another workflow template, add your files to the same `workflow-templates` directory.

## Next steps

Expand Down
4 changes: 2 additions & 2 deletions content/actions/sharing-automations/reusing-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ You can view the reused workflows referenced in your {% data variables.product.p

Reusable workflows and composite actions both help you to avoid duplication. Whereas reusable workflows allow you to reuse an entire workflow, with multiple jobs and steps, composite actions combine multiple steps that you can then run within a job step, just like any other action. For more information, see "[AUTOTITLE](/actions/using-workflows/avoiding-duplication)."

### Reusable workflows and starter workflows
### Reusable workflows and workflow templates

Starter workflows 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. Within a 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 commit SHA when referencing the reusable workflow, 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 "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)."
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 workflow template and some or all of the work of writing the workflow will be done for them. Within a workflow template, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a commit SHA when referencing the reusable workflow, 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 "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)."

For more information, see "[AUTOTITLE](/actions/using-workflows/creating-starter-workflows-for-your-organization)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,23 @@ 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 Go language. For more information, see [Getting started with Go](https://golang.org/doc/tutorial/getting-started).

## Using a Go starter workflow
## Using a Go workflow template

{% data reusables.actions.starter-workflow-get-started %}
{% data reusables.actions.workflow-templates-get-started %}

{% data variables.product.prodname_dotcom %} provides a Go starter workflow that should work for most Go projects. The subsequent sections of this guide give examples of how you can customize this starter workflow.
{% data variables.product.prodname_dotcom %} provides a Go workflow template that should work for most Go projects. The subsequent sections of this guide give examples of how you can customize this workflow template.

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %}
{% data reusables.actions.new-starter-workflow %}
1. The "Choose a workflow" page shows a selection of recommended starter workflows. Search for "go".
1. The "Choose a workflow" page shows a selection of recommended workflow templates. Search for "go".
1. Filter the selection of workflows by clicking **Continuous integration**.
1. On the "Go - by {% data variables.product.prodname_actions %}" workflow, click **Configure**.

![Screenshot of the "Choose a workflow" page. The "Configure" button on the "Go" workflow is highlighted with an orange outline.](/assets/images/help/actions/starter-workflow-go.png)

{%- ifversion ghes %}
If you don't find the "Go - by {% data variables.product.prodname_actions %}" starter workflow, copy the following workflow code to a new file called `go.yml` in the `.github/workflows` directory of your repository.
If you don't find the "Go - by {% data variables.product.prodname_actions %}" workflow template, copy the following workflow code to a new file called `go.yml` in the `.github/workflows` directory of your repository.

```yaml copy
name: Go
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,21 @@ We recommend that you have a basic understanding of Java and the Ant framework.

{% data reusables.actions.enterprise-setup-prereq %}

## Using an Ant starter workflow
## Using an Ant workflow template

{% data reusables.actions.starter-workflow-get-started %}
{% data reusables.actions.workflow-templates-get-started %}

{% data variables.product.prodname_dotcom %} provides a starter workflow for Ant that should work for most Java with Ant projects. The subsequent sections of this guide give examples of how you can customize this starter workflow.
{% data variables.product.prodname_dotcom %} provides a workflow template for Ant that should work for most Java with Ant projects. The subsequent sections of this guide give examples of how you can customize this workflow template.

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %}
{% data reusables.actions.new-starter-workflow %}
1. The "Choose a workflow" page shows a selection of recommended starter workflows. Search for "Java with Ant".
1. The "Choose a workflow" page shows a selection of recommended workflow templates. Search for "Java with Ant".
1. On the "Java with Ant" workflow, click **Configure**.

{%- ifversion ghes %}

If you don't find the "Java with Ant" starter workflow, copy the following workflow code to a new file called `ant.yml` in the `.github/workflows` directory of your repository.
If you don't find the "Java with Ant" workflow template, copy the following workflow code to a new file called `ant.yml` in the `.github/workflows` directory of your repository.

```yaml copy
name: Java CI
Expand Down Expand Up @@ -90,7 +90,7 @@ We recommend that you have a basic understanding of Java and the Ant framework.

You can use the same commands that you use locally to build and test your code.

The starter workflow will run the default target specified in your _build.xml_ file. Your default target will commonly be set to build classes, run tests and package classes into their distributable format, for example, a JAR file.
The workflow template will run the default target specified in your _build.xml_ file. Your default target will commonly be set to build classes, run tests and package classes into their distributable format, for example, a JAR file.

If you use different commands to build your project, or you want to run a different target, you can specify those. For example, you may want to run the `jar` target that's configured in your `_build-ci.xml_` file.

Expand Down
Loading

0 comments on commit 1a924d0

Please sign in to comment.