Add the GitHub Workflows ReadMe

This commit is contained in:
Michael Mintz 2020-02-06 03:31:13 -05:00
parent 4da5073608
commit ae49bf2b17
1 changed files with 49 additions and 0 deletions

View File

@ -0,0 +1,49 @@
### Running browser-based test automation with [GitHub Workflows](https://github.com/seleniumbase/SeleniumBase/actions) by using [SeleniumBase](https://github.com/seleniumbase/SeleniumBase)
----------
### Step 0. Create a fork of [SeleniumBase](https://github.com/seleniumbase/SeleniumBase) on GitHub to help you get started.
* **(You'll be using your own repo eventually.)**
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_2.png "Create a fork of SeleniumBase")
----------
### Step 1. From the GitHub Actions tab, choose to set up a Python package Workflow.
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_1.png "GitHub Actions/Workflows")
----------
### Step 2. Add your workflow ``.yml`` script.
* **(If using a SeleniumBase fork, the script from https://github.com/seleniumbase/SeleniumBase/blob/master/.github/workflows/python-package.yml should already exist to guide you.)**
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_3.png "GitHub Actions/Workflows")
### Step 3. Commit your file if it doesn't already exist.
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_4.png "GitHub Actions/Workflows")
----------
### Step 4. Your tests will now run on every pull request and on every commit to the ``master`` branch.
* **(See https://github.com/seleniumbase/SeleniumBase/actions for the SeleniumBase example.)**
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_5.png "GitHub Actions/Workflows")
* **(You can click inside each run for more details.)**
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_6.png "GitHub Actions/Workflows")
* **(You can also see the specific steps being performed by each command.)**
![](https://cdn2.hubspot.net/hubfs/100006/images/github_workflows_7.png "GitHub Actions/Workflows")
----------
### Step 5. Congratulations! You now know how to create and run browser tests with GitHub Workflows!
### **Study [SeleniumBase](https://github.com/seleniumbase/SeleniumBase) to learn more!**