starter-workflows README

The project's README from github.com/actions/starter-workflows. As one markdown file: README.md.

Starter Workflows

These are the workflow files for helping people get started with GitHub Actions. They're presented whenever you start to create a new GitHub Actions workflow.

If you want to get started with GitHub Actions, you can use these starter workflows by clicking the "Actions" tab in the repository where you want to create a workflow.

Note

Thank you for your interest in this GitHub repo, however, right now we are not taking contributions.

We continue to focus our resources on strategic areas that help our customers be successful while making developers' lives easier. While GitHub Actions remains a key part of this vision, we are allocating resources towards other areas of Actions and are not taking contributions to this repository at this time. The GitHub public roadmap is the best place to follow along for any updates on features we’re working on and what stage they’re in.

We are taking the following steps to better direct requests related to GitHub Actions, including:

  1. We will be directing questions and support requests to our Community Discussions area

  2. High Priority bugs can be reported through Community Discussions or you can report these to our support team https://support.github.com/contact/bug-report.

  3. Security Issues should be handled as per our security.md

We will still provide security updates for this project and fix major breaking changes during this time.

You are welcome to still raise bugs in this repo.

Directory structure

Each workflow must be written in YAML and have a .yml extension. They also need a corresponding .properties.json file that contains extra metadata about the workflow (this is displayed in the GitHub.com UI).

For example: ci/django.yml and ci/properties/django.properties.json.

Valid properties

Categories

Variables

These variables can be placed in the starter workflow and will be substituted as detailed below:

How to test templates before publishing

Disable template for public

The template author adds a labels array in the template's properties.json file with a label preview. This will hide the template from users, unless user uses query parameter preview=true in the URL. Example properties.json file:

{
    "name": "Node.js",
    "description": "Build and test a Node.js project with npm.",
    "iconName": "nodejs",
    "categories": ["Continuous integration", "JavaScript", "npm", "React", "Angular", "Vue"],
    "labels": ["preview"]
}

For viewing the templates with preview label, provide query parameter preview=true to the new workflow page URL. Eg. https://github.com/<owner>/<repo_name>/actions/new?preview=true.

Enable template for public

Remove the labels array from properties.json file to publish the template to public

starter-workflows (actions/starter-workflows)

Searching Database…

12.2K ·GitHub
Starter-workflows
Что это такое?Это официальная коллекция стартовых шаблонов воркфлоу для GitHub Actions. Она показывается, когда вы создаёте новый воркфлоу на вкладке Actions репозитория.
Это библиотека или просто набор файлов с шаблонами?Это репозиторий YAML-шаблонов воркфлоу, разложенных по категориям (ci, deployments, automation, code-scanning, pages). Для каждого шаблона есть парный файл метаданных .properties.json. Устанавливать его как библиотеку не нужно.
Как использовать эти стартовые воркфлоу в моём репозитории?Перейдите на вкладку 'Actions' в репозитории и создайте новый воркфлоу; GitHub сам предложит подходящие стартовые шаблоны из этого репозитория.
Что нужно, чтобы добавить сюда свой шаблон?Каждому новому шаблону нужен YAML-файл с расширением .yml и парный файл .properties.json, в котором задаются поля name, description, iconName, creator и categories.
Как посмотреть новый шаблон до того, как он станет публичным?Добавьте в properties.json шаблона массив labels со значением preview. Тогда шаблон будет скрыт, пока пользователь не откроет страницу создания нового воркфлоу с параметром запроса preview=true.
Что делают специальные переменные вроде $default-branch?Заполнители $default-branch, $protected-branches и $cron-daily автоматически заменяются реальными значениями: основной веткой репозитория, защищёнными ветками или случайным ежедневным временем для cron.
К каким категориям может относиться шаблон?Шаблоны можно отнести к категориям continuous-integration, deployment, testing, code-quality, code-review, dependency-management, monitoring, automation, utilities, Pages и Hugo, а также к тегам языков и технологического стека.
What are similar projects?gh-aw, awesome-actions, gitea, super-linter, runner-images, workflow_templates, ai-software-factory, factory
Which topics is it in?cicd, ci-cd, yaml, template, github-actions, workflow, github, ci, json, devops, automation, typescript
Creator
actions
Size
3.8 MB
Stars
12.2K
Updated
CommitAug 03
Age
7y
Commits · 90 Days