chore: v2.4.0 (#138)

Co-authored-by: Renovate Bot <[email protected]>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Liliia Pelypenko <[email protected]>

Author: 4 people

docs/images/tags.png

@@ -52,6 +52,34 @@ test.meta({
 }).skip('Example planned test', async (t) => {
     // Test Code
 });
+
+test.meta({
+    severity: Severity.TRIVIAL,
+    issue: 'TEST-ISSUE',
+    description: 'An example discription',
+    epic: 'Example Epic Ticket',
+    feature: 'Example Feature Ticket',
+    story: 'Example Story Ticket',
+    suite: 'Main Example Group',
+    tags: ['automated', 'smoke', 'e2e']
+    // ... any other key: value property as custom metadata
+})('Example test with metadata', async (t) => {
+    // Test Code
+});
+
+test.meta({
+    severity: Severity.TRIVIAL,
+    issue: 'TEST-ISSUE',
+    description: 'An example discription',
+    epic: 'Example Epic Ticket',
+    feature: 'Example Feature Ticket',
+    story: 'Example Story Ticket',
+    suite: 'Main Example Group',
+    tags: 'e2e'
+    // ... any other key: value property as custom metadata
+})('Example test with metadata where tag can be a string', async (t) => {
+    // Test Code
+});
 ```
 
 ## Pré-defined metadata
@@ -63,6 +91,7 @@ test.meta({
 | Epic, Feature, Story  | To sort the tests based on the `epic`, `feature`, and/or `story`, these metadata options can be used to form a tree structure. The tree is structured as follows: An epic can have multiple features, a feature can have multiple stories, and a story can have multiple tests. |
 | Suite  | Within the Allure Report, the tests are organized by `fixture` by default. For a more expansive organization of the tests and fixtures, the `suite` parameter can be set. When the `suite` parameter is set within a `test`, a subcategory is created within the `fixture` that will group all tests that have the same `suite` parameter together. When the `suite` parameter is set within a `fixture`, a parent category is created that will group multiple fixtures that have the same `suite` parameter.  |
 | skipReason  | A test meta tag to allow showing skip reason in allure categories.  |
+| tags  | A test meta tag to allow showing tags in allure report. It is recommended to pass "tags" as an array of strings |
 
 ## Custom metadata
 
@@ -88,6 +117,10 @@ Skip reason will be shown as a message on test result overview:
 
 Skip message can be used as a filter in allure categories view.
 
+### Example of a test result view for a test with 'tags' metadata
+
+![Example of the metadata for test with "tags" metadata.](../images/tags.png)
+
 ## Categories
 
 Example of a custom `allure-categories.config.js` with `skipReason` message to be in `messageRegex` filter: 

docs/usage/metadata.md

@@ -14,9 +14,8 @@
   },
   "homepage": "https://github.com/isaaceindhoven/testcafe-reporter-allure#readme",
   "scripts": {
-    "test:e2e:cli": "testcafe firefox tests/example.spec.ts --reporter allure --screenshots path=allure/screenshots,takeOnFails=true",
     "test:doc:example": "testcafe firefox tests/docMetaExample.spec.ts --reporter allure --screenshots path=allure/screenshots,takeOnFails=true",
-    "allure": "allure generate ./allure/allure-results --clean -o ./allure/allure-report && allure open ./allure/allure-report",
+    "allure": "allure generate ./allure-results --clean -o ./allure/allure-report && allure open ./allure/allure-report",
     "list:browsers": "testcafe --list-browsers"
   },
   "devDependencies": {

examples/base-implementation-with-custom-config/package.json

@@ -8,6 +8,7 @@ test.meta({
   feature: 'Example Feature Ticket',
   story: 'Example Story Ticket',
   suite: 'Main Example Group',
+  tags: ['e2e', 'automated', 'smoke'],
   // ... any other key: value property as custom metadata
 })('Example test with metadata', async () => {
   // Test Code
@@ -38,9 +39,20 @@ test
     feature: 'Example Feature Ticket',
     story: 'Example Story Ticket',
     suite: 'Main Example Group',
+    tags: ['e2e', 'not-automated'],
     skipReason: 'Skipped: Not automated',
     // ... any other key: value property as custom metadata
   })
   .skip('Example planned test', async () => {
     // Test Code
   });
+
+test
+  .meta({
+    suite: 'Another Example Group',
+    tags: 'not-automated', // string tags are also supported
+    skipReason: 'Not automated',
+  })
+  .skip('Example not automated e2e test 3', async () => {
+    // planned test
+  });