docs: update configuration for merge request options and strategies#55
Merged
Conversation
Co-authored-by: Copilot <copilot@github.com>
Contributor
Coverage |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation around configuration options, specifically reorganizing and clarifying merge request merge strategy settings in docs/configuration.md.
Changes:
- Moves
mergeRequest.mergeMethoddocumentation out of the assignment-level keys list into a dedicated “Merge Request options” section. - Adds a “Merge Request keys” table and YAML snippet demonstrating
mergeRequest.mergeMethod. - Relocates release-related notes to the Release section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -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 | | |||
There was a problem hiding this comment.
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`) | |
Comment on lines
+322
to
+324
| <assignment>: | ||
| mergeRequest: | ||
| mergeMethod: merge # merge | semi_linear | ff |
There was a problem hiding this comment.
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.