Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Léo-Paul Géneau
gitlab-ce
Commits
ad8cd349
Commit
ad8cd349
authored
Mar 01, 2018
by
Rémy Coutable
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document the ee-files-location-check CI job
Signed-off-by:
Rémy Coutable
<
remy@rymai.me
>
parent
bac9bb18
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
39 additions
and
0 deletions
+39
-0
doc/development/ee_features.md
doc/development/ee_features.md
+39
-0
No files found.
doc/development/ee_features.md
View file @
ad8cd349
...
@@ -33,6 +33,40 @@ rest of the code should be as close to the CE files as possible.
...
@@ -33,6 +33,40 @@ 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
[
single code base
]:
https://gitlab.com/gitlab-org/gitlab-ee/issues/2952#note_41016454
### Detection of EE-only files
For each commit (except on
`master`
), the
`ee-files-location-check`
CI job tries
to detect if there are any new files that are EE-only. If any file is detected,
the job fails with an explanation of why and what to do to make it pass.
Basically, the fix is simple:
`git mv <file> ee/<file>`
.
#### How to name your branches?
For any EE branch, the job will try to detect its CE counterpart by removing any
`ee-`
prefix or
`-ee`
suffix from the EE branch name, and matching the last
branch that contains it.
For instance, from the EE branch
`new-shiny-feature-ee`
(or
`ee-new-shiny-feature`
), the job would find the corresponding CE branches:
-
`new-shiny-feature`
-
`ce-new-shiny-feature`
-
`new-shiny-feature-ce`
-
`my-super-new-shiny-feature-in-ce`
#### Whitelist some EE-only files that cannot be moved to `ee/`
The
`ee-files-location-check`
CI job provides a whitelist of files or folders
that cannot or should not be moved to
`ee/`
. Feel free to open an issue to
discuss adding a new file/folder to this whitelist.
For instance, it was decided that moving EE-only files from
`qa/`
to
`ee/qa/`
would make it difficult to build the
`gitLab-{ce,ee}-qa`
Docker images and it
was [not worth the complexity].
[
not worth the complexity
]:
https://gitlab.com/gitlab-org/gitlab-ee/issues/4997#note_59764702
### EE-only features
### EE-only features
If the feature being developed is not present in any form in CE, we don't
If the feature being developed is not present in any form in CE, we don't
...
@@ -52,6 +86,11 @@ is applied not only to models. Here's a list of other examples:
...
@@ -52,6 +86,11 @@ is applied not only to models. Here's a list of other examples:
-
`ee/app/validators/foo_attr_validator.rb`
-
`ee/app/validators/foo_attr_validator.rb`
-
`ee/app/workers/foo_worker.rb`
-
`ee/app/workers/foo_worker.rb`
This works because for every path that are present in CE's eager-load/auto-load
paths, we add the same
`ee/`
-prepended path in [
`config/application.rb`
].
[
`config/application.rb`
]:
https://gitlab.com/gitlab-org/gitlab-ee/blob/d278b76d6600a0e27d8019a0be27971ba23ab640/config/application.rb#L41-51
### EE features based on CE features
### EE features based on CE features
For features that build on existing CE features, write a module in the
For features that build on existing CE features, write a module in the
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment