Skip to content

Commit 1f3fed5

Browse files
committed
Update the docs about GitHub Actions
1 parent 0e396e5 commit 1f3fed5

File tree

3 files changed

+29
-32
lines changed

3 files changed

+29
-32
lines changed

integrations/github/ReadMe.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22

33
> **Table of Contents / Navigation:**
44
> - [**Actions/Workflows**](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md)
5+
> - [**Extras/Action-Integrations**](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/extras.md)

integrations/github/workflows/ReadMe.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -51,35 +51,3 @@
5151
### Congratulations! You now know how to create and run browser tests with GitHub Actions/Workflows!
5252

5353
### **Study [SeleniumBase](https://github.com/seleniumbase/SeleniumBase) to learn more!**
54-
55-
----------
56-
----------
57-
58-
### **Integrations for GitHub Actions:**
59-
60-
### Slack Notifications - [rtCamp/action-slack-notify](https://github.com/rtCamp/action-slack-notify) can be used to send notifications to Slack.
61-
62-
**Usage:**
63-
* Create a slack integration webhook if you don't have one already.
64-
* Create a ``SLACK_WEBHOOK`` secret on your repository with the webhook token value.
65-
* For this particular action, ``SLACK_CHANNEL`` is an optional environment variable that defaults to the webhook token channel if not specified.
66-
* The following example shows how to put a link to your workflow as the ``SLACK_MESSAGE`` (Lets you see artifacts pushed up, such as from the SeleniumBase Presenter feature!):
67-
```
68-
- name: Slack notification
69-
uses: rtCamp/action-slack-notify@master
70-
env:
71-
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
72-
SLACK_CHANNEL: general
73-
SLACK_ICON_EMOJI: rocket
74-
SLACK_USERNAME: SeleniumBase
75-
SLACK_MESSAGE: 'Actions workflow completed successful! :tada: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}'
76-
```
77-
78-
### Uploading Artifacts:
79-
* Here's an example using [upload-artifact@v2](https://github.com/actions/upload-artifact) to push up a SeleniumBase-generated presentation as an artifact. (You can use this together with the Slack notification action to view the presentation directly from GitHub)
80-
```
81-
- uses: actions/upload-artifact@v2
82-
with:
83-
name: Click to download the presentation
84-
path: saved_presentations/my_presentation.html
85-
```
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Integrations for GitHub Actions:
2+
3+
### Uploading Artifacts:
4+
* Here's an example using [upload-artifact@v2](https://github.com/actions/upload-artifact) to push up a SeleniumBase-generated artifact.
5+
```
6+
- uses: actions/upload-artifact@v2
7+
with:
8+
name: Click to download the presentation
9+
path: saved_presentations/my_presentation.html
10+
```
11+
12+
### Slack Notifications - [rtCamp/action-slack-notify](https://github.com/rtCamp/action-slack-notify) can be used to send notifications to Slack.
13+
14+
**Usage:**
15+
* Create a slack integration webhook if you don't have one already.
16+
* Create a ``SLACK_WEBHOOK`` secret on your repository with the webhook token value.
17+
* For this particular action, ``SLACK_CHANNEL`` is an optional environment variable that defaults to the webhook token channel if not specified.
18+
* The following example shows how to put a link to your workflow as the ``SLACK_MESSAGE`` (Lets you see artifacts pushed up, such as from the SeleniumBase Presenter feature!):
19+
```
20+
- name: Slack notification
21+
uses: rtCamp/action-slack-notify@master
22+
env:
23+
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
24+
SLACK_CHANNEL: general
25+
SLACK_ICON_EMOJI: rocket
26+
SLACK_USERNAME: SeleniumBase
27+
SLACK_MESSAGE: 'Actions workflow completed successful! :tada: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}'
28+
```

0 commit comments

Comments
 (0)