Skip to content
Snippets Groups Projects
README.md 1.24 KiB
Newer Older
Daniel Sabatino's avatar
Daniel Sabatino committed
# Gitlab CI Templates for WCM Modules
Daniel Sabatino's avatar
Daniel Sabatino committed
A set of CI templates and scripts used for CI/CD of WCM modules and themes hosted on UCR.

### Composer Installation
- Add the wcm-osu repository to your composer.json.
```
    "repositories": [
        {   
            "type":"composer",
            "url":"https://code.osu.edu/api/v4/group/5741/-/packages/composer/packages.json"
        }
    ],
```
- Add code.osu.edu to the gitlab-domains setting in the config section of your composer.json.
```
    "config": {
        "gitlab-domains": [
            "code.osu.edu"
        ]
    }
```
Daniel Sabatino's avatar
Daniel Sabatino committed
- Require with composer. 
Daniel Sabatino's avatar
Daniel Sabatino committed
user@host> composer require --dev wcm-osu/wcm_template_ci_module
Daniel Sabatino's avatar
Daniel Sabatino committed

Daniel Sabatino's avatar
Daniel Sabatino committed
- Copy the [PROJECT_ROOT]/vendor/wcm-osu/wcm_template_ci_module/scaffold/.gitlab-ci.yml file to your [PROJECT_ROOT]. Be aware that if you're updating any existing CI configuration, previous customizations may be overwritten. 
Daniel Sabatino's avatar
Daniel Sabatino committed

- Adjust .gitlab-ci.yml as needed. Add .gitlab-ci.yml to your site repository. Commit and push to your site repository.

### Manual Installation
Daniel Sabatino's avatar
Daniel Sabatino committed
- Clone this repository to your machine. 
- Copy scaffold/.gitlab-ci.yml to your site root.
Daniel Sabatino's avatar
Daniel Sabatino committed
- Adjust .gitlab-ci.yml as needed. Add the .gitlab-ci.yml to your site repository. Commit and push to your site repository.