Commit fbf4145f authored by Evan Read's avatar Evan Read

Add markdownlint-cli 0.31.0 to project, and update linting image

Also disables new rules made available in new version until
documentation can be made to pass.
parent c9b14b77
...@@ -44,7 +44,7 @@ docs-lint markdown: ...@@ -44,7 +44,7 @@ docs-lint markdown:
- .default-retry - .default-retry
- .docs:rules:docs-lint - .docs:rules:docs-lint
# When updating the image version here, update it in /scripts/lint-doc.sh too. # When updating the image version here, update it in /scripts/lint-doc.sh too.
image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.15-vale-2.14.0-markdownlint-0.30.0 image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.15-vale-2.15.0-markdownlint-0.31.0
stage: lint stage: lint
needs: [] needs: []
script: script:
......
...@@ -22,6 +22,8 @@ no-emphasis-as-heading: false ...@@ -22,6 +22,8 @@ no-emphasis-as-heading: false
first-line-h1: false first-line-h1: false
code-block-style: code-block-style:
style: "fenced" style: "fenced"
emphasis-style: false
strong-style: false
proper-names: proper-names:
names: [ names: [
"Akismet", "Akismet",
......
...@@ -75,7 +75,7 @@ If a test failed in the project's default branch in the last 14 days, a message ...@@ -75,7 +75,7 @@ If a test failed in the project's default branch in the last 14 days, a message
## How to set it up ## How to set it up
To enable the Unit test reports in merge requests, you need to add To enable the Unit test reports in merge requests, you must add
[`artifacts:reports:junit`](yaml/artifacts_reports.md#artifactsreportsjunit) [`artifacts:reports:junit`](yaml/artifacts_reports.md#artifactsreportsjunit)
in `.gitlab-ci.yml`, and specify the path(s) of the generated test reports. in `.gitlab-ci.yml`, and specify the path(s) of the generated test reports.
The reports must be `.xml` files, otherwise [GitLab returns an Error 500](https://gitlab.com/gitlab-org/gitlab/-/issues/216575). The reports must be `.xml` files, otherwise [GitLab returns an Error 500](https://gitlab.com/gitlab-org/gitlab/-/issues/216575).
......
...@@ -142,7 +142,7 @@ database query: ...@@ -142,7 +142,7 @@ database query:
SELECT "users"."id" FROM "users" ORDER BY "users"."id" ASC LIMIT 1 SELECT "users"."id" FROM "users" ORDER BY "users"."id" ASC LIMIT 1
``` ```
![Reading the start `id` value](img/each_batch_users_table_iteration_1_v13_7.png) ![Reading the start ID value](img/each_batch_users_table_iteration_1_v13_7.png)
Notice that the query only reads data from the index (`INDEX ONLY SCAN`), the table is not Notice that the query only reads data from the index (`INDEX ONLY SCAN`), the table is not
accessed. Database indexes are sorted so taking out the first item is a very cheap operation. accessed. Database indexes are sorted so taking out the first item is a very cheap operation.
...@@ -155,7 +155,7 @@ to get a "shifted" `id` value. ...@@ -155,7 +155,7 @@ to get a "shifted" `id` value.
SELECT "users"."id" FROM "users" WHERE "users"."id" >= 1 ORDER BY "users"."id" ASC LIMIT 1 OFFSET 5 SELECT "users"."id" FROM "users" WHERE "users"."id" >= 1 ORDER BY "users"."id" ASC LIMIT 1 OFFSET 5
``` ```
![Reading the end `id` value](img/each_batch_users_table_iteration_2_v13_7.png) ![Reading the end ID value](img/each_batch_users_table_iteration_2_v13_7.png)
Again, the query only looks into the index. The `OFFSET 5` takes out the sixth `id` value: this Again, the query only looks into the index. The `OFFSET 5` takes out the sixth `id` value: this
query reads a maximum of six items from the index regardless of the table size or the iteration query reads a maximum of six items from the index regardless of the table size or the iteration
...@@ -181,7 +181,7 @@ previous iteration in order to find out the next end `id` value. ...@@ -181,7 +181,7 @@ previous iteration in order to find out the next end `id` value.
SELECT "users"."id" FROM "users" WHERE "users"."id" >= 302 ORDER BY "users"."id" ASC LIMIT 1 OFFSET 5 SELECT "users"."id" FROM "users" WHERE "users"."id" >= 302 ORDER BY "users"."id" ASC LIMIT 1 OFFSET 5
``` ```
![Reading the second end `id` value](img/each_batch_users_table_iteration_4_v13_7.png) ![Reading the second end ID value](img/each_batch_users_table_iteration_4_v13_7.png)
Now we can easily construct the `users` query for the second iteration. Now we can easily construct the `users` query for the second iteration.
......
...@@ -128,7 +128,7 @@ function run_locally_or_in_docker() { ...@@ -128,7 +128,7 @@ function run_locally_or_in_docker() {
$cmd $args $cmd $args
elif hash docker 2>/dev/null elif hash docker 2>/dev/null
then then
docker run -t -v ${PWD}:/gitlab -w /gitlab --rm registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.15-vale-2.14.0-markdownlint-0.30.0 ${cmd} ${args} docker run -t -v ${PWD}:/gitlab -w /gitlab --rm registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.15-vale-2.15.0-markdownlint-0.31.0 ${cmd} ${args}
else else
echo echo
echo " ✖ ERROR: '${cmd}' not found. Install '${cmd}' or Docker to proceed." >&2 echo " ✖ ERROR: '${cmd}' not found. Install '${cmd}' or Docker to proceed." >&2
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment