Commit 64ef7e9f authored by Cédric OLIVIER's avatar Cédric OLIVIER
Browse files

Merge branch 'feat/component' into 'main' 

feat: migrate to CI/CD component

See merge request to-be-continuous/sqlfluff!22
parents b4140e01 7ea798d8

.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,13 +4,36 @@ This project implements a GitLab CI/CD template to lint your SQL files (whicheve 


## 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/sqlfluff/gitlab-ci-sqlfluff@1.2.0

    # 2: set/override component inputs

    inputs:

      working-dir: "data" # ⚠ 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/sqlfluff'

    ref: '1.2.0'

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



variables:

  # 2: set/override template variables

  SQLFLUFF_WORKING_DIR: "data" # ⚠ this is only an example

```



## Global configuration
@@ -18,10 +41,10 @@ include: 
The SQLFluff template uses some global configuration used throughout all jobs.





| Name                  | Description                            | Default value     |

| Input / Variable | Description                            | Default value     |

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

| `SQLFLUFF_IMAGE`      | The Docker image used to run SQLFluff  | `registry.hub.docker.com/sqlfluff/sqlfluff:latest`   |

| `SQLFLUFF_WORKING_DIR`| SQLFluff working directory, scope of configuration and sql files used | `.` |

| `image` / `SQLFLUFF_IMAGE` | The Docker image used to run SQLFluff  | `registry.hub.docker.com/sqlfluff/sqlfluff:latest`   |

| `working-dir` / `SQLFLUFF_WORKING_DIR` | SQLFluff working directory, scope of configuration and sql files used | `.` |



sqlfluff needs to set a [dialect](https://docs.sqlfluff.com/en/stable/dialects.html) you can do it by setting `SQLFLUFF_LINT_ARGS` to `--dialect my_dialect` or provide a [configuration file](https://docs.sqlfluff.com/en/stable/configuration.html) in your repository.
@@ -35,9 +58,9 @@ This job performs a [lint](https://docs.sqlfluff.com/en/stable/cli.html#sqlfluff 


It uses the following variable:



| Name                  | Description                              | Default value     |

| Input / Variable | Description                              | Default value     |

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

| `SQLFLUFF_LINT_ARGS`  | Lint [options and arguments](https://docs.sqlfluff.com/en/stable/cli.html#sqlfluff-lint) | _none_ |

| `lint-args` / `SQLFLUFF_LINT_ARGS` | Lint [options and arguments](https://docs.sqlfluff.com/en/stable/cli.html#sqlfluff-lint) | _none_ |



In addition to a textual report in the console, this job produces the following reports, kept for one day:

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": "Lint your SQL files (whichever your dialect) with [SQLFluff](https://docs.sqlfluff.com)",

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

  "kind": "analyse",

  "prefix": "sqlfluff",

  "is_component": true,

  "variables": [

    {

      "name": "SQLFLUFF_IMAGE",

logo.png

+7.16 KiB (34.9 KiB)
Loading image diff...