Skip to content

Commit c1841e1

Browse files
committed
Update README with env vars used during test runs
Signed-off-by: Yiannis <[email protected]>
1 parent 533d336 commit c1841e1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,15 @@ See the following (automatically tested) examples:
172172
- [github/example_organization_test.go](github/example_organization_test.go)
173173
- [github/example_repository_test.go](github/example_repository_test.go)
174174

175+
176+
If you need to run `make test` for your fork/branch you may need to supply the following environment variables:
177+
- GIT_PROVIDER_ORGANIZATION : For GitHub this should be an organization whereas for GitLab this should be a top-level group. As this environment variable is used for both test suites, the name of the GitHub organization must match the name of the GitLab top-level group. Also, this organization needs to have its repository default branch set to `main`.
178+
- GIT_PROVIDER_USER : This should be the same username for both GitHub and GitLab.
179+
- GITLAB_TEST_TEAM_NAME : An existing GitLab group.
180+
- GITLAB_TEST_SUBGROUP : An existing GitLab subgroup of the GIT_PROVIDER_ORGANIZATION top-level group.
181+
- GITHUB_TOKEN : A GitHub token with `repo`, `admin:org` and `delete_repo` permissions.
182+
- GITLAB_TOKEN: A GitLab token with `api` scope.
183+
175184
## Maintainers
176185

177186
In alphabetical order:
@@ -181,6 +190,7 @@ In alphabetical order:
181190
- Simon Howe, [@foot](https://github.com/foot)
182191
- Dinos Kousidis, [@dinosk](https://github.com/dinosk)
183192
- Stefan Prodan, [@stefanprodan](https://github.com/stefanprodan)
193+
- Yiannis Triantafyllopoulos, [@yiannistri](https://github.com/yiannistri)
184194

185195
## Getting Help
186196

0 commit comments

Comments
 (0)