summaryrefslogtreecommitdiff
path: root/doc/development
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2018-03-28 18:12:20 +0000
committerRémy Coutable <remy@rymai.me>2018-03-28 18:12:20 +0000
commit160d29b869673a8f2a3e57cf509e30b93e82a014 (patch)
tree867ce1a2ba2d446b5ffd86af4a107c4e777c9e4b /doc/development
parentc61634659bf81940a9bde740163f19bf094eab04 (diff)
parentd5f0d89f9d48dc14fbc3091547d6ff257a868586 (diff)
downloadgitlab-ce-160d29b869673a8f2a3e57cf509e30b93e82a014.tar.gz
Merge branch '44752-remove-ee-specific-comments' into 'master'
Remove EE-specific comment markers from CE Closes #44752 See merge request gitlab-org/gitlab-ce!18054
Diffstat (limited to 'doc/development')
-rw-r--r--doc/development/ee_features.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/doc/development/ee_features.md b/doc/development/ee_features.md
index 4842626d1ad..3ba03d2d591 100644
--- a/doc/development/ee_features.md
+++ b/doc/development/ee_features.md
@@ -33,6 +33,26 @@ rest of the code should be as close to the CE files as possible.
[single code base]: https://gitlab.com/gitlab-org/gitlab-ee/issues/2952#note_41016454
+### EE-specific comments
+
+When complete separation can't be achieved with the `ee/` directory, you can wrap
+code in EE specific comments to designate the difference from CE/EE and add
+some context for someone resolving a conflict.
+
+```rb
+# EE-specific start
+stub_licensed_features(variable_environment_scope: true)
+# EE specific end
+```
+
+```haml
+-# EE-specific start
+= render 'ci/variables/environment_scope', form_field: form_field, variable: variable
+-# EE-specific end
+```
+
+EE-specific comments should not be backported to CE.
+
### Detection of EE-only files
For each commit (except on `master`), the `ee-files-location-check` CI job tries
@@ -654,12 +674,13 @@ to avoid conflicts during CE to EE merge.
}
}
-/* EE-specific styles */
+// EE-specific start
.section-body.ee-section-body {
.section-title {
background: $gl-header-color-cyan;
}
}
+// EE-specific end
```
## gitlab-svgs