Skip to content

docs: update configuration for merge request options and strategies #55

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
obcode merged 1 commit into from
Apr 23, 2026
Merged

docs: update configuration for merge request options and strategies #55

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
31 changes: 22 additions & 9 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,6 @@ Patterns are **regular expressions**, so:
| `description` | GitLab project description | `generated by glabs` | Visible in UI |
| `accesslevel` | Initial project access (see below) | `developer` | Can be changed later with `setaccess` |
| `containerRegistry` | Enable container registry | `false` | Auto-enabled if `release.dockerImages` set |

Copilot AI Apr 23, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assignment-level YAML example above includes a mergeRequest: block, but the “Assignment-level keys” table no longer mentions it. Consider adding a row for mergeRequest (or mergeRequest.mergeMethod) and/or a pointer to the “Merge Request options” section so readers can discover the option from the key list.

Suggested change
| `containerRegistry` | Enable container registry | `false` | Auto-enabled if `release.dockerImages` set |
| `containerRegistry` | Enable container registry | `false` | Auto-enabled if `release.dockerImages` set |
| `mergeRequest` | Merge request settings for the assignment | — | See Merge Request options (for example `mergeRequest.mergeMethod`) |

Copilot uses AI. Check for mistakes.
| `mergeRequest.mergeMethod` | Merge strategy (see below) | `merge` | Applied at project creation |
| `students` | Override/add assignment-specific students | — | Merged with course-level |
| `groups` | Override/add assignment-specific groups | — | Merged with course-level |

Expand Down Expand Up @@ -309,9 +308,29 @@ release:
| `mergeRequest.pipeline` | Wait for CI | `false` | Require passing checks |
| `dockerImages` | Images to build | `[]` | Creates container registry entries |

### Merge method values
**Notes:**

- Container registry is auto-enabled when `dockerImages` is set
- Enables GitLab Flow workflow for releases
- Works with CI/CD pipeline to build/deploy

## Merge Request options

Control how merge requests are merged in every generated project:

```yaml
<assignment>:
mergeRequest:
mergeMethod: merge # merge | semi_linear | ff
Comment on lines +322 to +324

Copilot AI Apr 23, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The YAML snippet under “Merge Request options” uses <assignment>: at the top level, but other examples show assignments nested under <course>:. This is likely to confuse users about where mergeRequest belongs; update the snippet to match the established <course> -> <assignment> structure (or explicitly state that it’s inside an assignment block).

Suggested change
<assignment>:
mergeRequest:
mergeMethod: merge # merge | semi_linear | ff
<course>:
<assignment>:
mergeRequest:
mergeMethod: merge # merge | semi_linear | ff

Copilot uses AI. Check for mistakes.
```

The assignment-level `mergeRequest.mergeMethod` option controls how merge requests are merged in every generated project:
### Merge Request keys

| Key | Purpose | Default | Notes |
|---|---|---|---|
| `mergeRequest.mergeMethod` | Merge strategy for all MRs | `merge` | Applied at project creation |

### Merge method values

| Value | GitLab UI name | Description |
|---|---|---|
Expand All @@ -327,12 +346,6 @@ blatt01:
mergeMethod: ff # Students must keep a linear history
```

**Notes:**

- Container registry is auto-enabled when `dockerImages` is set
- Enables GitLab Flow workflow for releases
- Works with CI/CD pipeline to build/deploy

## Full example

```yaml
Expand Down
Loading