Skip to content

Commit

Permalink
Clarify integration test setup instructions (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
sersorrel authored Jan 22, 2024
1 parent 9c0e062 commit e15695b
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,21 +104,26 @@ Run tests with [Tox][]
poetry run tox
```

To run integration tests, you need a git repository set up with token access and
a branch named after your git repo username (stripped of any @domain if your
username is an email address).
To run integration tests, you need:

Make sure the artifacts/repo section of ~/.softpack/core/config.yml is
- a git repository, hosted on e.g. GitHub or GitLab
- an access token for the git repository
- for GitLab, this requires the "developer" role and the "write_repository" scope
- for GitHub, this requires read-write access to repository contents
- a branch to run the tests on (must match `username` in the config below)
- the appropriate SoftPack config, described below

Make sure the artifacts/repo section of `~/.softpack/core/config.yml` is
configured correctly:

```
```yaml
artifacts:
repo:
url: https://github.com/[your-org]/development-softpack-artifacts.git
username: [your-username]
author: [your-name]
email: [your-email]
writer: [your-token]
url: https://github.com/[your-org]/development-softpack-artifacts.git # HTTPS link to the repo
username: [your-username] # for whatever platform the repo is hosted on
author: [your-name] # can be anything
email: [your-email] # can be anything
writer: [your-token] # the access token for the repo (or your password for the repo host)
```
Then enable the integration tests by suppling --repo to `poetry run pytest`, or
Expand Down

0 comments on commit e15695b

Please sign in to comment.