This tutorial primarily focuses on GitHub users that are first-time Testspace users. It provides a reference project to walk-through to get them up to speed on using Testspace.
There are three main sections on this page to complete the setup required:
- Install the Testspace App on your account
- Create a testspace.getting-started repo on your GitHub account
- Create a Testspace project associated with the repo
You will be introduced to
Publishing automated test results and implementing
Manual Tests as Code using GitHub.
The tutorial requires installing Testspace on your personal GitHub account or a GitHub organization account that you are an owner of:
- Use https://github.com/marketplace/testspace-com to sign up and install the Testspace App using your GitHub credentials
The tutorial can be used with your personal GitHub account and a corresponding Testspace organization based on your "personal" account. Personal Testspace accounts are always free.
Note you must be an
ownerof the GitHub organization to install Testspace using the GitHub Marketplace.
When using a GitHub Organization account and a corresponding Testspace organization, it is easy to invite other GitHub members.
- At the Testspace Organization level, select the
- Click the
Invite Usersbutton at the upper right of the page.
- A list of all GitHub organization members will be presented.
- Select the members to invite.
- Click the ''SUBMIT'' button at the bottom of the dialog.
For more Testspace account admin information click here.
The GitHub getting started repo includes (i) a CI workflow file used to
publish automated test results and (ii) a set of test specs used for
The repo can be
forking the repo, make sure to go to your forked repo
settings add update the following:
- Enable Workflows. When a repository is forked, the GitHub Actions for automation has to be manually enabled.
- Enable Issues. Issues will be required to be
enabled, to allow Issues to be auto-generated by Testspace when a Manual test case fails.
Forked Repos require the settings to be updated.
To create a copy of the
testspace.getting-started repo the following instructions can be used:
Create your repo - assumed name
Pull a copy of the tutorial repo. Make sure to replace
git init git remote add origin https://github.com/USER-NAME/testspace.getting-started.git git pull https://github.com/testspace-com/testspace.getting-started.git git branch -M main git push -u origin main
After the repo has been created and updated, login into your Testspace account. You will now create a Testspace
project referencing the newly created GitHub
In this example, the Testspace project is used to manage results from test automation and execute the manual tests.
A Testspace project can be used for publishing test automation results, executing manual tests, or both.
To create a Testspace
project click on the "New Project" button at the top right of the Testspace landing page. A dialog will appear listing all of the Repositories available. Select the name of the newly created GitHub
repo (i.e. "testspace.getting-started") and press
your-github-org:testspace.getting-started project is now ready to be used for testing. The
main space in the project is accessible by clicking the
project that you created.
The following are some terms used throughout this tutorial.
test spec- A set of test instructions represented by a single markdown file. Aka spec.
suite- Contains the results of the execution of a test spec.
space- Contains results and test suites for a branch in the repo.
At this point, a new Testspace project has been created and connected to a new GitHub repo.
Let's start doing things.