diff --git a/src/internals/023-github-actions.md b/src/internals/023-github-actions.md new file mode 100644 index 00000000..fcca4d8d --- /dev/null +++ b/src/internals/023-github-actions.md @@ -0,0 +1,32 @@ +# 023 — GitHub Actions + +This document defines naming convention for the GitHub actions configuration files. + +## Inputs and Outputs + +Input names and output names must use kebab-case format. + +For example: + +```yaml +inputs: + my-input: + description: 'My input' +``` + +## Secrets and Environment Variables + +Secret names and environment variable names must use SCREAMING_SNAKE_CASE format. + +For example: + +```yaml +secrets: + MY_SECRET: + description: 'My secret' +``` + +```yaml +env: + MY_ENV_VAR: 1 +``` diff --git a/src/internals/index.md b/src/internals/index.md index 6dac084b..beecee2d 100644 --- a/src/internals/index.md +++ b/src/internals/index.md @@ -28,3 +28,4 @@ It covers guidelines, workflows, and best practices for maintaining and developi - [020 — Package release](020-package-release.md) - Release process for packages - [021 — Changelog and upgrade](021-changelog-upgrade.md) - Maintaining changelogs and upgrade notes - [022 — Config groups](022-config-groups.md) - Configuration group organization +- [023 - GitHub Actions](023-github-actions.md) - GitHub actions configuration