Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mogtofu33/gitlab-ci-drupal

MIRROR for https://gitlab.com/mog33/gitlab-ci-drupal
https://github.com/mogtofu33/gitlab-ci-drupal

drupal drupal-8 drupal8 gitlab-ci php-qa sass-lint

Last synced: 4 months ago
JSON representation

MIRROR for https://gitlab.com/mog33/gitlab-ci-drupal

Awesome Lists containing this project

README 

        
# Gitlab CI for Drupal 9 / 10








[Gitlab CI](https://docs.gitlab.com/ee/ci/README.html) for a

[Drupal](https://www.drupal.org) module / theme or full project.



Include **Build**, **Testing**, **Code quality**, **Metrics** and more...



For any **issue**, please use the [Gitlab-CI project page](https://gitlab.com/mog33/gitlab-ci-drupal/-/issues)



Based on an include behavior, ie you don't have to copy all files from this project.



## Prerequisites



- Gitlab CI with a [runner that support docker](https://docs.gitlab.com/runner/)

- Minimal understanding of [Gitlab CI](https://about.gitlab.com/stages-devops-lifecycle/continuous-integration/)

and [Gitlab CI Yaml](https://docs.gitlab.com/ee/ci/yaml)



## Documentation



- [Documentation for GitLab CI Drupal](https://mog33.gitlab.io/gitlab-ci-drupal)



## Quick setup



### Quick setup for a Drupal module / theme



Push your module / theme to a Gitlab with CI and runners enabled.



[Gitlab.com](https://gitlab.com) offer some CI pipeline minutes/month on free accounts.



- Copy [starter.gitlab-ci.yml](https://gitlab.com/mog33/gitlab-ci-drupal/-/raw/4.x-dev/starter.gitlab-ci.yml)

file as a `.gitlab-ci.yml` at the root of your Drupal module or theme

(same level as `my_module_or_theme.info.yml` file).

- If your project is not on [Gitlab.com](https://gitlab.com), edit the `include` section et the beginning.

- Edit the `variables` and uncomment the section under `Override default variables for a module`

- Create and push your branch, see the pipeline running for basic code standard and lint.



External [module demo](https://gitlab.com/gitlab-ci-drupal/demo-gitlab-ci-drupal-module), real module example [Content moderation edit notify](https://gitlab.com/mog33/content_moderation_edit_notify)



For more option and details see the [full documentation](https://mog33.gitlab.io/gitlab-ci-drupal).



### Quick setup for a full Drupal project



Push your project to a Gitlab with CI and runners enabled.



[Gitlab.com](https://gitlab.com) offer some CI pipeline minutes/month on free accounts.



Assuming your project include a `composer.json` file from the

[Drupal project](https://www.drupal.org/docs/develop/using-composer/using-composer-to-install-drupal-and-manage-dependencies).



- Copy [starter.gitlab-ci.yml](https://gitlab.com/mog33/gitlab-ci-drupal/-/raw/4.x-dev/starter.gitlab-ci.yml) file as a `.gitlab-ci.yml` in your project

- If you are using _Behat_ you must add your tests in a `behat_tests` folders at the root of your Drupal project (same level as `composer.json` file).

  - As a starting point you can look in the [behat_tests](./behat_tests) folder of this project.

- Put your custom code in the `web/modules/custom` and `web/themes/custom` folders of your project.

- Create and push your branch, see the pipeline running for basic code standard, lint, tests and metrics.



External [project demo](https://gitlab.com/gitlab-ci-drupal/demo-gitlab-ci-drupal-project).



As an example you can check my project on a Drupal template:

[Drupal project advanced template](https://gitlab.com/mog33/drupal-composer-advanced-template)



For more option and details see the [full documentation](https://mog33.gitlab.io/gitlab-ci-drupal).



----



Want some help implementing this on your project? I provide Drupal expertise

as a freelance, just [contact me](https://developpeur-drupal.com/en).



If you want to support this project, you can:



- [](https://bit.ly/34jPKcE)

- Hire me as a freelance for any Drupal related work

- Promote me to any company looking for any Drupal related work

- Help me with testing / documentation / grammar fixes / use cases