1
0
mirror of synced 2025-12-25 11:03:37 -05:00
Files
docs/content/actions/using-workflows/using-starter-workflows.md
Lucas Costi 7b86410fc3 Improve Actions short titles (#31394)
Co-authored-by: Martin Lopes <martin389@github.com>
2022-10-05 04:34:45 +00:00

4.5 KiB

title, shortTitle, intro, redirect_from, versions, type, topics
title shortTitle intro redirect_from versions type topics
Using starter workflows Use starter workflows {% data variables.product.product_name %} provides starter workflows for a variety of languages and tooling.
/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
/actions/learn-github-actions/using-starter-workflows
fpt ghes ghae ghec
* * * *
tutorial
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, {% data variables.product.product_name %} will suggest a starter workflow file that installs your Node.js packages and runs your tests.{% ifversion actions-starter-template-ui %} You can search and filter to find relevant starter workflows.{% endif %}

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

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."

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.

  2. The "{% ifversion actions-starter-template-ui %}Choose a workflow{% else %}Choose a workflow template{% endif %}" page shows a selection of recommended starter workflows. Find the starter workflow that you want to use, then click {% ifversion actions-starter-template-ui %}Configure{% else %}Set up this workflow{% endif %}.{% ifversion actions-starter-template-ui %} To help you find the starter workflow that you want, you can search for keywords or filter by category.{% endif %}

    {% ifversion actions-starter-template-ui %}Configure this workflow{% else %}Set up this workflow{% endif %}

  3. 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.

  4. 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."

  5. Optionally, make additional changes. For example, you might want to change the value of on to change when the workflow runs.

  6. Click Start commit.

  7. Write a commit message and decide whether to commit directly to the default branch or to open a pull request.

Further reading