diff options
| author | Tim Zallmann <tzallmann@gitlab.com> | 2018-04-03 16:42:24 +0300 |
|---|---|---|
| committer | Tim Zallmann <tzallmann@gitlab.com> | 2018-04-03 16:42:24 +0300 |
| commit | be1523c1ba9fa439a2525a1b18179a419ecb6b2d (patch) | |
| tree | a81171a53fd44e11188ae10a852bdbd604a6a099 /doc | |
| parent | 2e6e4ea80c6a74e1ad90bb121a3157e1dfb7ed8d (diff) | |
| parent | 1dc43af6ff9357724264ba9e9185d1c6a01bd58c (diff) | |
Merge branch 'add-documentation-about-backporting-changes' into 'master'
Add documentation about backporting changes from EE to CE
See merge request gitlab-org/gitlab-ce!18003
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/ee_features.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/development/ee_features.md b/doc/development/ee_features.md index 3ba03d2d591..287143d6255 100644 --- a/doc/development/ee_features.md +++ b/doc/development/ee_features.md @@ -644,6 +644,7 @@ information on managing page-specific javascript within EE. To separate EE-specific styles in SCSS files, if a component you're adding styles for is limited to only EE, it is better to have a separate SCSS file in appropriate directory within `app/assets/stylesheets`. +See [backporting changes](#backporting-changes) for instructions on how to merge changes safely. In some cases, this is not entirely possible or creating dedicated SCSS file is an overkill, e.g. a text style of some component is different for EE. In such cases, @@ -683,6 +684,19 @@ to avoid conflicts during CE to EE merge. // EE-specific end ``` +### Backporting changes from EE to CE + +When working in EE-specific features, you might have to tweak a few files that are not EE-specific. Here is a workflow to make sure those changes end up backported safely into CE too. +(This approach does not refer to changes introduced via [csslab](https://gitlab.com/gitlab-org/csslab/).) + +1. **Make your changes in the EE branch.** If possible, keep a separated commit (to be squashed) to help backporting and review. +1. **Open merge request to EE project.** +1. **Apply the changes you made to CE files in a branch of the CE project.** (Tip: Use `patch` with the diff from your commit in EE branch) +1. **Open merge request to CE project**, referring it's a backport of EE changes and link to MR open in EE. +1. Once EE MR is merged, the MR towards CE can be merged. **But not before**. + +**Note:** regarding SCSS, make sure the files living outside `/ee/` don't diverge between CE and EE projects. + ## gitlab-svgs Conflicts in `app/assets/images/icons.json` or `app/assets/images/icons.svg` can |