Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(testing): add option ciGroupName to @nx/jest/plugin #29365

Merged
merged 1 commit into from
Jan 9, 2025
+741 −218
Merged

feat(testing): add option ciGroupName to @nx/jest/plugin #29365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/generated/packages/jest/documents/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,27 @@ target with that name which can be used in CI to run the tests for each file in
}
```

### Customizing atomized unit/e2e tasks group name

By default, the atomized tasks group name is derived from the `ciTargetName`. For example, atomized tasks for the `e2e-ci` target will be grouped under the name "E2E (CI)" when displayed in Nx Cloud or `nx show project <project> --web` UI.
You can customize that name by explicitly providing the optional `ciGroupName` plugin option as such:

```json {% fileName="nx.json" %}
{
"plugins": [
{
"plugin": "@nx/jest/plugin",
"include": ["e2e/**/*"],
"options": {
"targetName": "e2e-local",
"ciTargetName": "e2e-ci",
"ciGroupname": "My E2E tests (CI)"
}
}
]
}
```

### How @nx/jest Infers Tasks

{% callout type="note" title="Inferred Tasks" %}
Expand Down
21 changes: 21 additions & 0 deletions docs/shared/packages/jest/jest-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,27 @@ target with that name which can be used in CI to run the tests for each file in
}
```

### Customizing atomized unit/e2e tasks group name

By default, the atomized tasks group name is derived from the `ciTargetName`. For example, atomized tasks for the `e2e-ci` target will be grouped under the name "E2E (CI)" when displayed in Nx Cloud or `nx show project <project> --web` UI.
You can customize that name by explicitly providing the optional `ciGroupName` plugin option as such:

```json {% fileName="nx.json" %}
{
"plugins": [
{
"plugin": "@nx/jest/plugin",
"include": ["e2e/**/*"],
"options": {
"targetName": "e2e-local",
"ciTargetName": "e2e-ci",
"ciGroupname": "My E2E tests (CI)"
}
}
]
}
```

### How @nx/jest Infers Tasks

{% callout type="note" title="Inferred Tasks" %}
Expand Down
Loading
Loading