Commit 9abd31f1 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

feat: migrate to CI/CD component 

⚠️ requires GitLab 16.6 or later
parent 013e5a28

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ include: 
    file: '/templates/validation.yml'

  - project: 'to-be-continuous/bash'

    ref: '3.3'

    file: 'templates/gitlab-ci-bash.yml'

    file: '/templates/gitlab-ci-bash.yml'

  - project: 'to-be-continuous/semantic-release'

    ref: '3.7'

    file: '/templates/gitlab-ci-semrel.yml'

README.md

+29 −6
Original line number Diff line number Diff line
@@ -4,23 +4,46 @@ This project implements a GitLab CI/CD template for [GNU Make](https://www.gnu.o 


## Usage



In order to include this template in your project, add the following to your `gitlab-ci.yml`:

This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component-in-a-cicd-configuration) 

or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.



### Use as a CI/CD component



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the component

  - component: gitlab.com/to-be-continuous/make/gitlab-ci-make@1.3.0

    # 2: set/override component inputs

    inputs:

      image: "image-with-my-build-tools:latest" # ⚠ this is only an example

```



### Use as a CI/CD template (legacy)



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the template

  - project: 'to-be-continuous/make'

    ref: '1.3.0'

    file: '/templates/gitlab-ci-make.yml'



variables:

  # 2: set/override template variables

  MAKE_IMAGE: "image-with-my-build-tools:latest" # ⚠ this is only an example

```



## Global configuration



The GNU Make template uses some global configuration used throughout all jobs.



| Name                  | Description                            | Default value     |

| Input / Variable | Description                            | Default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `MAKE_IMAGE`          | The Docker image used to run GNU Make<br/>:warning: **set the image required by your project** (see next chapter)  | `registry.hub.docker.com/alpinelinux/build-base` |

| `MAKE_PROJECT_DIR`    | The root directory of the Makefile project. | `.` |

| `image` / `MAKE_IMAGE` | The Docker image used to run GNU Make<br/>:warning: **set the image required by your project** (see next chapter)  | `registry.hub.docker.com/alpinelinux/build-base` |

| `project-dir` / `MAKE_PROJECT_DIR` | The root directory of the Makefile project. | `.` |



### Which image?
@@ -54,9 +77,9 @@ This job is expected to perform **build** and if possible **unit tests** all at 


It uses the following variable:



| Name                  | Description                              | Default value     |

| Input / Variable | Description                              | Default value     |

| --------------------- | ---------------------------------------- | ----------------- |

| `MAKE_BUILD_ARGS`     | Make [options](https://www.gnu.org/software/make/manual/html_node/Options-Summary.html) and [goals](https://www.gnu.org/software/make/manual/html_node/Goals.html) for the build & test job | `all test` |

| `build-args` / `MAKE_BUILD_ARGS` | Make [options](https://www.gnu.org/software/make/manual/html_node/Options-Summary.html) and [goals](https://www.gnu.org/software/make/manual/html_node/Goals.html) for the build & test job | `all test` |



### Build Output

bumpversion.sh

+2 −2
Original line number Diff line number Diff line
@@ -27,13 +27,13 @@ if [[ "$curVer" ]]; then 
  log_info "Bump version from \\e[33;1m${curVer}\\e[0m to \\e[33;1m${nextVer}\\e[0m (release type: $relType)..."



  # replace in README

  sed -e "s/ref: '$curVer'/ref: '$nextVer'/" README.md > README.md.next

  sed -e "s/ref: *'$curVer'/ref: '$nextVer'/" -e "s/ref: *\"$curVer\”/ref: \”$nextVer\”/" -e "s/component: *\(.*\)@$curVer/component: \1@$nextVer/" README.md > README.md.next

  mv -f README.md.next README.md



  # replace in template and variants

  for tmpl in templates/*.yml

  do

    sed -e "s/\"$curVer\"/\"$nextVer\"/" "$tmpl" > "$tmpl.next"

    sed -e "s/command: *\[\"--service\", \"\(.*\)\", \"$curVer\"\]/command: [\"--service\", \"\1\", \"$nextVer\"]/" "$tmpl" > "$tmpl.next"

    mv -f "$tmpl.next" "$tmpl"

  done

else

kicker.json

+2 −0
Original line number Diff line number Diff line
@@ -3,6 +3,8 @@ 
  "description": "GitLab CI template for [GNU Make](https://www.gnu.org/software/make/)",

  "template_path": "templates/gitlab-ci-make.yml",

  "kind": "build",

  "prefix": "make",

  "is_component": true,

  "variables": [

    {

      "name": "MAKE_IMAGE",

logo.png

−1.39 KiB (28 KiB)
Loading image diff...