Skip to content

Update share-report-ui.mdx #688

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

Merged
IDoneShaveIt merged 1 commit into from
Feb 16, 2023
Merged

Update share-report-ui.mdx #688

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
20 changes: 17 additions & 3 deletions docs/quickstart/share-report-ui.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ To enable the Slack results summary when hosting the report, you will need to co
After you [set up a Slack app and token](/integrations/slack#slack-integration-setup) you can run the following command:

```shell
edr send-report --aws-profile-name <AWS_PROFILE> --s3-bucket-name <BUCKET_NAME> --slack-token <SLACK_TOKEN> --slack-channel-name <CHANNEL_NAME>
edr send-report --google-service-account-path <SERVICE_ACCOUNT_PATH> --gcs-bucket-name <BUCKET_NAME> --slack-token <SLACK_TOKEN> --slack-channel-name <CHANNEL_NAME>
```

#### Hosting the report as a website
Expand Down Expand Up @@ -149,9 +149,23 @@ update_bucket_website: [true | false]

</Accordion>

### Slack summary configurations
### Slack summary configuration

If you share the report via Slack, the Slack notification will also include the summary of the test results by default.
If you host the report, you will need to configure the Slack platform as well in order to enable the Slack results summary.
After you [set up a Slack app and token](/integrations/slack#slack-integration-setup) you can run the following command:

The following configurations allow you to adjust the Slack test result summary.

AWS S3:
```shell
edr send-report --aws-profile-name <AWS_PROFILE> --s3-bucket-name <BUCKET_NAME> --slack-token <SLACK_TOKEN> --slack-channel-name <CHANNEL_NAME>
```

GCS:
```shell
edr send-report --google-service-account-path <SERVICE_ACCOUNT_PATH> --gcs-bucket-name <BUCKET_NAME> --slack-token <SLACK_TOKEN> --slack-channel-name <CHANNEL_NAME>
```


#### Filter results summary

Expand Down