4.2 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. |
|
|
tutorial |
|
{% data reusables.actions.enterprise-github-hosted-runners %}
About starter workflows
Starter workflows are templates that help you to create your own {% data variables.product.prodname_actions %} workflows for a repository. They offer an alternative to starting from a blank workflow file and are useful because some of the work will already have been done for you.
{% 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. Anyone with write access to the organization's github repository can set up a starter workflow. For more information, see "AUTOTITLE."
Choosing and using a starter workflow
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.actions.new-starter-workflow %}
-
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 %}
-
If the starter workflow contains comments detailing additional setup steps, follow these steps.
There are guides to accompany many of the starter workflows for building and testing projects. For more information, see "AUTOTITLE."
-
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 "AUTOTITLE." -
Optionally, make additional changes. For example, you might want to change the value of
onto change when the workflow runs. -
Click Start commit.
-
Write a commit message and decide whether to commit directly to the default branch or to open a pull request.