- edited description
GitLab CI: rename / move .gitlab-ci.yml to ci/gitlab/gitlab-ci.yml
There is a way to tell GitLab: "this project uses this yaml file", so it does not have to be in the root: https://gitlab.com/okapiframework/okapi/settings/ci_cd expand General pipelines and see Custom CI config path.
Pros:
- Cleaner root, everything that belongs to the GitLab CI is in the ci/gitlab folder
- No invisible files. To me hiding important files with a . feels wrong. And makes the cross-platform experience worse: I can see that file in Windows, but not on Linux.
- Easier to keep different build projects in sync. Everything you need is in ci/gitlab, no need to also diff some hidden files in root.
- Might even have all files for all projects in one place (ci/gitlab), for instance gitlab-ci-okapi.yaml, gitlab-ci-xliff-toolkit.yaml, gitlab-ci-integration-tests.yaml. So when you fix one we can fix all of them in one commit.
Cons:
- The file is not where one who is familiar with GitLab would expect it
- The info on where the file is would be hidden somewhere in the GitLab preferences
Comments (6)
-
reporter -
It seems the Cons are not as bad and the Pros are good.
-
@nmihai_2000 , I am OK with this proposal in general, however, I have some doubts about having the
gitlab-ci
files for all projects in one place. As far as I understand, that would entail the usage of git submodules, wouldn't it? Wasn't we against the git submodules in that case? If this is all about copying the files from one project to another, then I do not think it would make our life easier. I'd rather have just onegitlab-ci
file per project.In order to mitigate the cons to some extent, we have to notice this in README.
-
reporter OK, then I will do the non-controversial part: move / rename the yaml and document it in README. Will not create project-specific files.
-
reporter - marked as enhancement
-
reporter - changed status to resolved
Both Okapi & Xliff-Toolkit
- Log in to comment