Skip to content

Commit 0bd7408

Browse files
committed
Updated GitHub Actions template documentation
1 parent b1592b3 commit 0bd7408

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

docs/github-actions-templates.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- DO NOT EDIT THIS FILE!
22
3-
It was automatically created by task/scripts/github-documentation-update at Tue Apr 8 10:14:32 CEST 2025.
3+
It was automatically created by task/scripts/github-documentation-update at Tue Apr 8 13:30:36 CEST 2025.
44
-->
55
# Github Actions templates
66

@@ -11,8 +11,14 @@ to match the new templates.
1111

1212
## Naming conventions
1313

14-
* Named after what a tool is concerned with, not how it's concerned with it.
15-
* Some configuration based on template type (drupal, symfony)
14+
* A workflow file is named after what it is _concerned_ with, not _how_ it's concerned with it and which tools are
15+
actually used, i.e. we have a [`markdown.yaml`](github/workflows/markdown.yaml) file and not a `markdownlint.yaml`
16+
file.
17+
* Some workflows are specific to a project type, currently `drupal` or `symfony`, and these sit in a project type
18+
subfolder, e.g. `github/workflows/drupal`.
19+
* Some tools require configuration files, and these sit in the `config` folder. Some tool configuration may be specific
20+
to a project type (or make sence only for a specific project type), and these specific config files sit in a project
21+
type subfolder, e.g. `config/drupal/php/.phpcs.xml.dist` and `config/drupal/twig/.twig-cs-fixer.dist.php`
1622

1723
## Templates
1824

task/templates/github-actions-templates.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,14 @@ to match the new templates.
77

88
## Naming conventions
99

10-
* Named after what a tool is concerned with, not how it's concerned with it.
11-
* Some configuration based on template type (drupal, symfony)
10+
* A workflow file is named after what it is _concerned_ with, not _how_ it's concerned with it and which tools are
11+
actually used, i.e. we have a [`markdown.yaml`](github/workflows/markdown.yaml) file and not a `markdownlint.yaml`
12+
file.
13+
* Some workflows are specific to a project type, currently `drupal` or `symfony`, and these sit in a project type
14+
subfolder, e.g. `github/workflows/drupal`.
15+
* Some tools require configuration files, and these sit in the `config` folder. Some tool configuration may be specific
16+
to a project type (or make sence only for a specific project type), and these specific config files sit in a project
17+
type subfolder, e.g. `config/drupal/php/.phpcs.xml.dist` and `config/drupal/twig/.twig-cs-fixer.dist.php`
1218

1319
## Templates
1420

0 commit comments

Comments
 (0)