Skip to content

Commit e5f60d4

Browse files
slackChannel flag - HYP
1 parent 487cfba commit e5f60d4

File tree

3 files changed

+56
-2
lines changed

3 files changed

+56
-2
lines changed

docs/deep-dive-into-hyperexecute-yaml.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -814,6 +814,36 @@ project:
814814

815815
***
816816

817+
### `slackChannel`
818+
819+
This flag allows you to receive real-time notifications about your Job updates in a Slack channel of your choice, ensuring that your team stays informed about all the Job status directly within your preferred Slack workspace.
820+
821+
:::note Prerequisites
822+
- To avail this feature, connect with our <span className="doc__lt" onClick={() => window.openLTChatWidget()}>Support Team.</span>
823+
- 📕 You must first [*integrate Slack*](https://www.lambdatest.com/support/docs/hyperexecute-slack-integration/) from the **Integration** section of the LambdaTest dashboard.
824+
:::
825+
826+
After successfully integrating Slack, specify the Slack channel where you want Job updates to be sent by updating your HyperExecute YAML file:
827+
828+
```yaml title="hyperexecute.yaml"
829+
slackChannel: hyperexecute-job-updates #slack channel name
830+
```
831+
> This feature does not work for **private** Slack channels.
832+
833+
Or, if you prefer using variable:
834+
835+
```yaml title="hyperexecute.yaml"
836+
slackChannel: ${channel}
837+
```
838+
839+
And then in your CLI/terminal, pass your desired channel name like:
840+
841+
```yaml
842+
./hyperexecute --vars "channel=hyperexecute-job-updates" #enter your slack channel name
843+
```
844+
845+
***
846+
817847
### `differentialUpload`
818848

819849
When you are working with relatively large codebases, and constantly updating and upgrading your test scripts. Getting them onto the HyperExecute platform for every run might consume extra time.

docs/hyperexecute-slack-integration.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,30 @@ Once you integrate Slack, you need to configure notification settings to get tes
8585
- Update the **Notification Time** as well.
8686
- Now run the test and visit the Slack channel to view the build notification containing Job Number, Job Status, Executed By, Started At, Job Duration, Test Duration etc.
8787

88-
## Step 4: Report a bug for a Failed Test
88+
## Receive Notification on Custom Slack Channels
89+
> - To avail this feature, connect with our <span className="doc__lt" onClick={() => window.openLTChatWidget()}>Support Team.</span>
90+
> - This feature does not work for **private** Slack channels.
91+
92+
After successfully integrating Slack, specify the Slack channel where you want Job updates to be sent by updating your HyperExecute YAML file:
93+
94+
```yaml title="hyperexecute.yaml"
95+
slackChannel: hyperexecute-job-updates #slack channel name
96+
```
97+
98+
Or, if you prefer using variable:
99+
100+
```yaml title="hyperexecute.yaml"
101+
slackChannel: ${channel}
102+
```
103+
104+
And then in your CLI/terminal, pass your desired channel name like:
105+
106+
```yaml
107+
./hyperexecute --vars "channel=hyperexecute-job-updates" #enter your slack channel name
108+
```
109+
110+
111+
## Report a bug for a Failed Test
89112

90113
- Click on the failed test. It will navigate you to the automation page.
91114
- Click on the bug icon.

docs/hyperexecute-yaml-parameters.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,8 @@ The **HyperExecute YAML** file serves as the foundational component for test exe
161161
| [alwaysRunPostSteps](/support/docs/deep-dive-into-hyperexecute-yaml/#alwaysrunpoststeps) | Boolean | Execute the Post Steps in every scenario case |
162162
| [cacheTestURL](/support/docs/deep-dive-into-hyperexecute-yaml/#cachetesturl) | Boolean |It enables users to cache static test files. |
163163
| [afterAll](/support/docs/deep-dive-into-hyperexecute-yaml/#afterall) | Map |It is used to run commands after the job has finished. |
164-
| [projectName](/support/docs/deep-dive-into-hyperexecute-yaml/#projectname) | String | Segregate data at a project/repo level |
164+
| [project](/support/docs/deep-dive-into-hyperexecute-yaml/#project) | String | Segregate data at a project/repo level |
165+
| [slackChannel](/support/docs/deep-dive-into-hyperexecute-yaml/#slackchannel) | String | Allows you to receive notifications of your Job updates directly in your preferred Slack channel. |
165166

166167
<nav aria-label="breadcrumbs">
167168
<ul className="breadcrumbs">

0 commit comments

Comments
 (0)