Skip to content

Clarify accepted values for projectQuery #950

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 4, 2025
Merged

Clarify accepted values for projectQuery #950

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/admin/code_hosts/gitlab.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,10 @@ Example config:
There are three fields for configuring which projects are mirrored/synchronized:

- [`projects`](/admin/code_hosts/gitlab#configuration): A list of projects in `{"name": "group/name"}` or `{"id": id}` format. The order determines the order in which we sync project metadata and is safe to change.
- [`projectQuery`](/admin/code_hosts/gitlab#configuration): A list of strings with one pre-defined option (`none`), and/or an URL path and query that targets the [GitLab Projects API endpoint](https://docs.gitlab.com/ee/api/projects.html), returning a list of projects.
- [`projectQuery`](/admin/code_hosts/gitlab#configuration): A list of strings. Accepted values include:
- The special value `none`, which will sync no repositories.
- Query parameters for the [GitLab Projects API endpoint](https://docs.gitlab.com/ee/api/projects.html). For example, `?archived=false`.
- A path and set of query parameters for any GitLab API endpoint that returns a list of repos. For example, `groups/mygroup/projects?visibility=public`.
- [`exclude`](/admin/code_hosts/gitlab#configuration): A list of projects to exclude which takes precedence over the `projects`, and `projectQuery` fields. It has the same format as `projects`.

### Troubleshooting
Expand Down