From 7135450ec14e7e47bf3e41dd65d399e5e315fa39 Mon Sep 17 00:00:00 2001 From: Andy McKay Date: Thu, 29 Jul 2021 09:24:43 -0700 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e276691..2c2f1b5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,8 @@ These are the workflow files for helping people get started with GitHub Actions. -**Directory structure:** +### Directory structure + * [ci](ci): solutions for Continuous Integration * [automation](automation): solutions for automating workflows. * [code-scanning](code-scanning): starter workflows for [Code Scanning](https://github.com/features/security) @@ -20,8 +21,16 @@ Each workflow must be written in YAML and have a `.yml` extension. They also nee For example: `ci/django.yml` and `ci/properties/django.properties.json`. -**Valid properties:** +### Valid properties + * `name`: the name shown in onboarding * `description`: the description shown in onboarding * `iconName`: the icon name in the relevant folder, for example `django` should have an icon `icons/django.svg`. Only SVG is supported at this time * `categories`: the categories that it will be shown under + +### Variables +These variables can be placed in the starter workflow and will be substituted as detailed below: + +* `$default-branch`: will substitute the branch from the repository, for example `main` and `master` +* `$protected-branches`: will substitue any protected branches from the repository. +* `$cron-daily`: will substitute a valid but random time within the day