Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ianjennings authored Sep 27, 2024
1 parent d3be076 commit d04ec7c
Showing 1 changed file with 12 additions and 44 deletions.
56 changes: 12 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,52 +14,20 @@ GitHub actions workflow files that generate and run end-to-end regression tests

---

## Prereqs
## Setup

1. You need a TestDriver API key
1. A live website URL to test
Fisrt, [fork this repository](https://github.com/testdriverai/quickstart-web/fork).

> Setup takes place entirely within GitHub and the TestDriver.ai dashboard. There's no need to clone this repo locally.
Next, [create a GitHub secret](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-a-repository) named `TESTDRIVER_API_KEY` using your API key from [the testdriver dashboard](https://app.dashcam.io/team).

### Setup
In the forked repository, [add a GitHub variable](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-an-environment) named `TESTDRIVER_WEBSITE`. The value should be the root domain of the website you want to test (ex `https://example.com`).

#### Fork this repo
## Test Generation

First, make a copy of this repository. This repo contains example workflow files to get you set up with TestDriver super fast.

[Click here to fork this repository](https://github.com/testdriverai/quickstart-web/fork).

#### Create a `TESTDRIVER_WEBSITE` variable.

Once the fork has been created, [add a GitHub variable](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-an-environment).

You must set the GitHub **variable** `TESTDRIVER_WEBSITE`. The value should be the root domain of the website you want to test (ex `https://example.com`).

#### Create a `TESTDRIVER_API_KEY` secret.

Once the fork has been created, [add a GitHub variable](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-an-environment).

You must set the GitHub **variable** `TESTDRIVER_WEBSITE`. The value should be the root domain of the website you want to test (ex `https://example.com`).

### Generate Test Plans

Your repo will come with 3 GitHub workflows already configured.

/actions/workflows/generate-explore.yml

Run the workflow

That will generate some test prompts

Review test results
Merge

Generate Regression Tests

Each Test Plan turns into a regression test

TestDriver opens a bunch of PRs



In the PR, press . to open in github.dev .
1. Run the `TestDriver.ai / Generate / Explore` workflow
- TestDriver will explore your website and open a new pull request with test plans
- Merge this PR into `main`
2. Run the `TestDriver.ai / Generate / Regression` workflow
- TestDriver will execute the test plans and generate regression tests
- Review each regression test and merge them into main
3. Regression tests will run on every PR and merge to main

0 comments on commit d04ec7c

Please sign in to comment.