Skip to content

Commit

Permalink
update README on test repository requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
cbartz committed Aug 1, 2024
1 parent 5a9ce51 commit 2792fee
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,10 @@ The command `tox -e test` can be used to run all tests, which are primarily inte
You can also select the repository against which to run the tests by setting
the `--repository` flag. The tests will fork the repository and create PRs against it.
Note that the tests are currently designed to work for specific Canonical repositories,
and may need to be for other repositories
and may need to be adapted for other repositories
(e.g. `tests.app.integration.test_target_branch_protection.test_fail`
assumes that certain collaborators are in the `users_bypass_pull_request_allowances` list).
assumes that certain collaborators are in the `users_bypass_pull_request_allowances` list).
The test repository must also have a branch protection defined for the main branch.
Also note that the forks are created in the personal space of the user whose token is being used,
and that the forks are not deleted after the run.
The reason for this is that it is only possible to create one fork of a repository,
Expand Down

0 comments on commit 2792fee

Please sign in to comment.