Commit df8a9e52 authored by Aurelien's avatar Aurelien Committed by Thomas Boni
Browse files

Resolve "Add a dictionary to our ci Spell_check to accept technical terms"

parent 7bace838
Loading
Loading
Loading
Loading
+3 −0
Original line number Diff line number Diff line
@@ -179,6 +179,9 @@ job_gitlab_labels:
  rules:
    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_PROJECT_PATH_SLUG == "r2devops-hub"'

spell_check:
  variables:
    PYSPELLING_CONFIG: '.spell_check/.pyspelling.yml'

mkdocs:
  variables:
+43 −0
Original line number Diff line number Diff line
# Use the spellchecker `aspell`
spellchecker: aspell
matrix:
- name: markdown
  sources:
  # Include every .md files
  # but ignore every .md files in node_modules
  - '**/*.md|!**/node_modules/**/*.md'
  aspell:
    lang: en
    d: en_US
  dictionary:
    wordlists:
    - .spell_check/dico.txt
    output: dictionary.dic
  pipeline:
  - pyspelling.filters.context:
      context_visible_first: true
      delimiters:
      # Ignore all emojis (even special ones)
      # (\u00a9|\u00ae|[\u2000-\u3300]|\ud83c[\ud000-\udfff]|\ud83d[\ud000-\udfff]|\ud83e[\ud000-\udfff])
      - open: '\\u'
        content: '(00a9|00ae|[2000-3300]|d83c[d000-dfff]|d83d[d000-dfff]|d83e[d000-dfff])'
        close: '[0-9|a-z|A-Z]'
  # This filter is used to understand correctly Markdown files
  # and not having errors in code blocks for example
  - pyspelling.filters.markdown:
      markdown_extensions:
        - pymdownx.superfences:
        - pymdownx.highlight:
        - pymdownx.emoji:
        - pymdownx.striphtml:
  # Example of filter for HTML attributes
  - pyspelling.filters.html:
      comments: false
      attributes:
      - title
      - alt
      - h1
      ignores:
      - 'code, pre'
  # Filter to not look at URLs
  - pyspelling.filters.url:

.spell_check/dico.txt

0 → 100644
+270 −0
Original line number Diff line number Diff line
# https://www.textfixer.com/tools/remove-duplicate-lines.php
ANSIBLE
Ansible
ansible
api
apidoc
apiDoc
APIs
argparse
args
arror
aspell
aws
behaviour
bom
bulary
bundler
Bzip
cdxgen
cfg
cfn
changelogs
checkov
checkstyle
ChkTex
cli
clj
CLOUDFORMATION
CloudFormation
CMake
cmake
CMakeLists
CodeSniffer
coffeelint
CoffeeScript
Coffeescript
CONFIG
config
credscan
CSHARP
css
customizable
CVE
CVSS
dartanalyzer
DAST
decrypted
decrypting
dep
depscan
detekt
developped
DevOps
Devops
dictionnaries
DLL
dll
DocBlocks
DOCKERFILE
Dockerfile
dockerfilelint
Docstring
DoD
dotenv
dotnet
Doxygen
EDITORCONFIG
editorconfig
emojipedia
ENV
eslint
exe
fka
fontawesome
Fortran
frontend
Github
github
GitLab
Gitlab
gitlab
Gitlab's
Gitleaks
gitleaks
glibc
globals
Golang
golangci
gosec
gradle
gulpfile
Gzip
HADOLINT
hadolint
hardcoded
html
HTMLHint
ide
IDL
Javascript
jq
js
JSON
json
jsondiff
jsonlint
jsonschema
jsp
JSX
jsx
Junit
junit
kaniko
kondo
kotlin
ktlint
kube
kubectl
KUBERNETES
Kubernetes
kubernetes
kubesec
KUBEVAL
Kubeval
kubeval
LaTeX
libc
LibXML
LibXslt
LINTER
Linter
linter
linters
lintr
linux
LUA
Lua
lua
luacheck
Markdownlint
markdownlint
md
minify
Mkdocs
mkdocs
musl
natively
newman
njsscan
nmap
NodeJS
nodejs
nosetests
NPM
npm
Nuget
Nugetconf
Nuspec
nuspec
NVD
ok
OPENAPI
OpenAPI
openapi
OpenSSL
opensslv
os
OSS
OWASP
perlcritic
php
PHPCS
PHPDoc
PHPSTAN
PHPStan
phpstan
phpunit
PHPUnit
pipenv
Pipfile
plsql
pmd
POWERSHELL
PowerShell
Powershell
pre
PROTOBUF
Protobuf
protolint
PSalm
PSScriptAnalyzer
px
Pylint
pylint
PySpelling
pytest
R2bulary
RAKU
Raku
README
RetireJS
repo
RuboCop
rubocop
runtime
sast
scala
serverless
Severities
SHA
Shellcheck
shellcheck
SHFMT
shfmt
ShiftLeftSecurity
sls
Snakefiles
SNAKEFMT
snakefmt
SNAKEMAKE
Snakemake
snakemake
sql
staticcheck
styleguide
Stylelint
stylelint
subdirectories
SwaggerUI
tcp
Tekton
tekton
TERRAFORM
Terraform
terraform
TERRAGRUNT
Terragrunt
terragrunt
TERRASCAN
terrascan
tflint
tfsec
tpl
Trivy
trivy
trivycache
trivyignore
TSX
tsx
ttk
TTL
txt
TypeScript
UI
Url
url
urls
Urls
vf
VHDL
vm
vulns
webserver
xml
YAML
yaml
YamlLint
Yamllint
yamllint
zaproxy
+3 −3
Original line number Diff line number Diff line
@@ -81,8 +81,8 @@ the following fields:
| `maintainer` | Gitlab username of the maintainer (be proud of your work) | **Yes** |
| `license` | Open-source license for the job. You can choose between `Apache-2.0` and `MIT` | **Yes** |
| `labels` | List of labels describing the job. It should describe a characteristic of your job. For example: Docker, PHP, Security, Quality... | No |
| `images` | Dictionary of docker image(s) used by the job. Please entre the image name as key and the tag version as value | **Yes** |
| `tools` | Dictionary of tool(s) installed during the job. Please entre the name as key and the version as value  | No |
| `images` | Dictionary of docker image(s) used by the job. Please enter the image name as key and the tag version as value | **Yes** |
| `tools` | Dictionary of tool(s) installed during the job. Please enter the name as key and the version as value  | No |

**Here is an example of `job.yml` 👇**

+2 −2
Original line number Diff line number Diff line
@@ -22,8 +22,8 @@ Even job is ready to use, it's always customizable for your specific usage.

___
### Mono repo
Alls job are manage in the same repository.
In comparison to multi repo where each job has his own repository and his own git project url.
All job are manage in the same repository.
In comparison to multi repository where each job has his own repository and his own git project url.

---

Loading