Skip to content

Commit

Permalink
Update ACADEMY_GITLAB_ACCESS_TOKEN doc
Browse files Browse the repository at this point in the history
  • Loading branch information
petrzpav committed Dec 7, 2023
1 parent 54ab005 commit 8dcbaf9
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ Caching directory used to share data between individual jobs and pipelines withi
List of files intended to be edited by users in distributed repositories. Files are separated by spaces and support [globbing](https://tldp.org/LDP/abs/html/globbingref.html), e.g. `image.png video.mp4 src/*.java`. Default value is `**/*`.

`ACADEMY_GITLAB_ACCESS_TOKEN`
[GitLab personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token) required for the API communication with `api` scope. It's recommended to use [Group Access Tokens](https://docs.gitlab.com/ee/user/group/settings/group_access_tokens.html). This **variable should be secret**, see [masked environmental CI variable](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project).
[GitLab personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token) required for the API communication with `api` scope. This **variable should be secret**, see [masked environmental CI variable](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project).
**Note**: If you share the repository, consider creating extra user for this purpose limited to a specific scope. Do not use [Group Access Token](https://docs.gitlab.com/ee/user/group/settings/group_access_tokens.html), unless it can create access tokens.

`ACADEMY_ASSIGN`
List of users for the [`academy distribute` command](documentation/academy-distribute.md). If this variable is empty, `ACADEMY_ASSIGN` file is used instead (which does not get distributed). Users can be separated by white-spaces or commas.
Expand Down

0 comments on commit 8dcbaf9

Please sign in to comment.