From 856887007ed53ed58e80f3b7ad26e3d898d4786a Mon Sep 17 00:00:00 2001 From: Julien Loizelet Date: Thu, 31 Oct 2024 16:05:14 +0900 Subject: [PATCH] docs(readme): Add more details about bats tags --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index dafdbd4..0f8e927 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ - [Available keys](#available-keys) - [Usage](#usage) - [Test your DDEV add-on](#test-your-ddev-add-on) + - [`bats` tags and the `test_command` input](#bats-tags-and-the-test_command-input) - [License](#license) - [Contribute](#contribute) @@ -167,6 +168,8 @@ Not required. Default: `""`. +For more details, see [below](#bats-tags-and-the-test_command-input). + --- ## Usage @@ -219,6 +222,30 @@ jobs: addon_ref: ${{ env.GITHUB_REF }} ``` +#### `bats` tags and the `test_command` input + +By default, this GitHub action is configured to exclude `release` tagged tests during _push_ and +_pull_request_ workflows by using the `bats tests --filter-tags '!release'` command. + +For other workflows, the default command is `bats tests`, meaning all tests, regardless of their tags, will run. + +To tag a test with a `release` tag, add `# bats test_tags=release` above the `@test` line in your bats file: + +```bash +# bats test_tags=release +@test "install from release" { + ... + + ... +} +``` + +This setup keeps release-specific tests out of everyday workflows unless you set a custom `test_command`. + +For more information on `bats` tags and filtering tests by tags, refer to the [bats documentation](https://bats-core.readthedocs.io/en/stable/writing-tests.html#tagging-tests). + + + ## License [Apache](LICENSE)