Commit 7b382d0f authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: fix broken links

parent 0c4013f7

README.md

+5 −5
Original line number Diff line number Diff line
@@ -46,27 +46,27 @@ The SQLFluff template uses some global configuration used throughout all jobs. 
| `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.

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/setting_configuration.html) in your repository.



If there is no configuration file in `SQLFLUFF_WORKING_DIR`, [default configuration](https://docs.sqlfluff.com/en/stable/configuration.html#defaultconfig) is used.

If there is no configuration file in `SQLFLUFF_WORKING_DIR`, [default configuration](https://docs.sqlfluff.com/en/stable/configuration/default_configuration.html) is used.



## Jobs



### `sqlfluff-lint` job



This job performs a [lint](https://docs.sqlfluff.com/en/stable/cli.html#sqlfluff-lint) analysis of your `SQL` code

This job performs a [lint](https://docs.sqlfluff.com/en/stable/reference/cli.html#sqlfluff-lint) analysis of your `SQL` code



It uses the following variable:



| Input / Variable | Description                              | Default value     |

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

| `lint-args` / `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/reference/cli.html#sqlfluff-lint) | _none_ |



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



| Report         | Format                                                                       | Usage             |

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

| `reports/sqlfluff-lint.native.json` | [SQLFluff JSON](https://docs.sqlfluff.com/en/stable/cli.html#cmdoption-sqlfluff-lint-f) format | - |

| `reports/sqlfluff-lint.native.json` | [SQLFluff JSON](https://docs.sqlfluff.com/en/stable/reference/cli.html#cmdoption-sqlfluff-lint-f) format | - |



### Secrets management

kicker.json

+1 −1
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ 
    },

    {

      "name": "SQLFLUFF_LINT_ARGS",

      "description": "Lint [options and arguments](https://docs.sqlfluff.com/en/stable/cli.html#sqlfluff-lint)",

      "description": "Lint [options and arguments](https://docs.sqlfluff.com/en/stable/reference/cli.html#sqlfluff-lint)",

      "advanced": true

    }

  ]

templates/gitlab-ci-sqlfluff.yml

+1 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ spec: 
      description: Sqlfluff working directory, scope of configuration and sql files used

      default: .

    lint-args:

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

      description: Lint [options and arguments](https://docs.sqlfluff.com/en/stable/reference/cli.html#sqlfluff-lint)

      default: ''

---

workflow: