From 0868b58e90b58bf73d5628213daf5f067dc653ca Mon Sep 17 00:00:00 2001 From: Ranabir Chakraborty Date: Thu, 3 Sep 2026 22:18:47 +0530 Subject: [PATCH] AMW-622 keycloak collection spelling and grammar checking for PRs --- .cspell/custom-dictionary.txt | 88 +++++++++++++++++++ .github/workflows/ci.yml | 12 +++ CONTRIBUTING.md | 2 +- cspell.json | 59 +++++++++++++ ...test_invalid_providerid_flow_creation.yml} | 0 .../keycloak_authentication_v2/verify.yml | 2 +- molecule/prepare.yml | 2 +- roles/keycloak/README.md | 2 +- roles/keycloak/defaults/main.yml | 2 +- roles/keycloak/meta/argument_specs.yml | 2 +- roles/keycloak_quarkus/README.md | 2 +- roles/keycloak_quarkus/defaults/main.yml | 2 +- .../keycloak_quarkus/meta/argument_specs.yml | 2 +- .../keycloak_quarkus/tasks/restart/serial.yml | 2 +- roles/keycloak_realm/defaults/main.yml | 2 +- 15 files changed, 170 insertions(+), 11 deletions(-) create mode 100644 .cspell/custom-dictionary.txt create mode 100644 cspell.json rename molecule/keycloak_modules/keycloak_authentication_v2/tests/{test_invalid_poviderid_flow_creation.yml => test_invalid_providerid_flow_creation.yml} (100%) diff --git a/.cspell/custom-dictionary.txt b/.cspell/custom-dictionary.txt new file mode 100644 index 0000000..d09b639 --- /dev/null +++ b/.cspell/custom-dictionary.txt @@ -0,0 +1,88 @@ +# Keycloak / Ansible domain-specific words +# Only terms NOT covered by built-in dictionaries + +# Product names and projects +Infinispan +infinispan +Wildfly +wildfly +keycloak + +# Red Hat product names +RHBK +rhbk +rhsso + +# Java / JBoss terms +Djboss +Djgroups +Dsun +ispn +ISPN +jaegertracing +jaxrs +jberet +JDBCPING +jgroups +JGROUPSPING +jndi +keytool +MPING +NAKACK +passivation +passivating +slsb +sfsb +TCPPING +tcpping +jdbcx +cacerts +changeit + +# Systemd directives +restartsec +runas +startlimitburst +systemdunit + +# Ansible terms +fqcn +FQCN + +# WildFly / JBoss terms +jbcs +modcluster + +# Linux / System terms +firewalld +cgroupns +zgrep + +# Configuration terms +xforwarded +PYTHONHTTPSVERIFY + +# Keycloak-specific +ciba +clusterless +remembertochangeme + +# Molecule / Testing +hspaans + +# CI / DevOps +sangonzal +rootperm + +# RST / Sphinx directives +toctree + +# Task names / verbs +Reown +decomment + +# British spellings (from upstream Keycloak docs) +recognises + +# Other +rmaster diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d299a43..54e1c3e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,6 +14,18 @@ on: - cron: '15 6 * * *' jobs: + spellcheck: + runs-on: ubuntu-latest + steps: + - name: Check out code + uses: actions/checkout@v7 + + - name: Run cspell + uses: streetsidesoftware/cspell-action@v9 + with: + incremental_files_only: false + use_cspell_files: true + ci: uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm secrets: inherit diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95b60ed..d9cb854 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Clone the repository, checkout the tag you want to build, or pick the main branc ### Development environment -Make sure your development machine has avilable: +Make sure your development machine has available: * python 3.11+ * virtualenv diff --git a/cspell.json b/cspell.json new file mode 100644 index 0000000..de2d0f4 --- /dev/null +++ b/cspell.json @@ -0,0 +1,59 @@ +{ + "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json", + "version": "0.2", + "language": "en", + "ignorePaths": ["changelogs/**", "CHANGELOG.rst"], + "files": [ + "**/*.md", + "**/*.rst", + "roles/*/meta/argument_specs.yml", + "roles/*/meta/main.yml", + "roles/*/tasks/**/*.yml", + "roles/*/defaults/*.yml", + "roles/*/handlers/*.yml", + "roles/*/templates/*.j2", + "molecule/**/*.yml", + "molecule/**/*.j2", + "playbooks/**/*.yml", + "meta/runtime.yml", + "meta/execution-environment.yml", + ".github/workflows/*.yml", + ".github/ISSUE_TEMPLATE/*.md", + "galaxy.yml" + ], + "dictionaries": [ + "custom-keycloak", + "java", + "bash", + "shellscript", + "fullstack", + "softwareTerms", + "software-tools", + "cpp-compound-words", + "python", + "docker", + "k8s", + "html", + "css", + "git", + "networking-terms", + "node", + "npm" + ], + "dictionaryDefinitions": [ + { + "name": "custom-keycloak", + "path": ".cspell/custom-dictionary.txt", + "addWords": true + } + ], + "ignoreRegExpList": [ + "/\\{\\{.*?\\}\\}/g", + "/`[^`]+`/g", + "/(https?:\\/\\/[^\\s)]+)/g", + "/\\|`?[a-z_]+`?\\|/g", + "/\\[.*?\\]\\(.*?\\)/g", + "/^\\s*authors?:.*$/gm", + "/^\\s*-\\s+.*<[^>]+>.*$/gm" + ] +} diff --git a/molecule/keycloak_modules/keycloak_authentication_v2/tests/test_invalid_poviderid_flow_creation.yml b/molecule/keycloak_modules/keycloak_authentication_v2/tests/test_invalid_providerid_flow_creation.yml similarity index 100% rename from molecule/keycloak_modules/keycloak_authentication_v2/tests/test_invalid_poviderid_flow_creation.yml rename to molecule/keycloak_modules/keycloak_authentication_v2/tests/test_invalid_providerid_flow_creation.yml diff --git a/molecule/keycloak_modules/keycloak_authentication_v2/verify.yml b/molecule/keycloak_modules/keycloak_authentication_v2/verify.yml index 9bf7f8b..1071186 100644 --- a/molecule/keycloak_modules/keycloak_authentication_v2/verify.yml +++ b/molecule/keycloak_modules/keycloak_authentication_v2/verify.yml @@ -24,4 +24,4 @@ - name: Invalid providerIds in execution tests ansible.builtin.include_tasks: - file: tests/test_invalid_poviderid_flow_creation.yml \ No newline at end of file + file: tests/test_invalid_providerid_flow_creation.yml \ No newline at end of file diff --git a/molecule/prepare.yml b/molecule/prepare.yml index 2d5f306..bf64b0a 100644 --- a/molecule/prepare.yml +++ b/molecule/prepare.yml @@ -36,7 +36,7 @@ ansible.builtin.set_fact: assets_server: "{{ lookup('env', 'MIDDLEWARE_DOWNLOAD_RELEASE_SERVER_URL') }}" -- name: "Download artefacts only if assets_server is set" +- name: "Download artifacts only if assets_server is set" when: - assets_server is defined - assets_server | length > 0 diff --git a/roles/keycloak/README.md b/roles/keycloak/README.md index 3d3b560..c000276 100644 --- a/roles/keycloak/README.md +++ b/roles/keycloak/README.md @@ -116,7 +116,7 @@ Role Defaults |`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port + keycloak_jboss_port_offset }}` | |`keycloak_frontend_url_force` | Force backend requests to use the frontend URL | `false` | |`keycloak_db_background_validation` | Enable background validation of database connection | `false` | -|`keycloak_db_background_validation_millis`| How frequenly the connection pool is validated in the background | `10000` if background validation enabled | +|`keycloak_db_background_validation_millis`| How frequently the connection pool is validated in the background | `10000` if background validation enabled | |`keycloak_db_background_validate_on_match` | Enable validate on match for database connections | `false` | |`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` | |`keycloak_log_target`| Set the destination of the keycloak log folder link | `/var/log/keycloak` | diff --git a/roles/keycloak/defaults/main.yml b/roles/keycloak/defaults/main.yml index e3233c5..b291ce6 100644 --- a/roles/keycloak/defaults/main.yml +++ b/roles/keycloak/defaults/main.yml @@ -60,7 +60,7 @@ keycloak_features: [] keycloak_ha_enabled: false ### Enable database configuration, must be enabled when HA is configured keycloak_db_enabled: "{{ True if keycloak_ha_enabled else False }}" -### Discovery protocol for ha cluster members, valus [ 'JDBC_PING', 'TCPPING' ] +### Discovery protocol for ha cluster members, values [ 'JDBC_PING', 'TCPPING' ] keycloak_ha_discovery: "{{ 'JDBC_PING' if keycloak_db_enabled else 'TCPPING' }}" ### Remote cache store on infinispan cluster keycloak_remote_cache_enabled: "{{ True if keycloak_ha_enabled else False }}" diff --git a/roles/keycloak/meta/argument_specs.yml b/roles/keycloak/meta/argument_specs.yml index 4f9829a..e4e9d4b 100644 --- a/roles/keycloak/meta/argument_specs.yml +++ b/roles/keycloak/meta/argument_specs.yml @@ -296,7 +296,7 @@ argument_specs: type: "bool" keycloak_db_background_validation_millis: default: "{{ 10000 if keycloak_db_background_validation else 0 }}" - description: "How frequenly the connection pool is validated in the background" + description: "How frequently the connection pool is validated in the background" type: 'int' keycloak_db_background_validate_on_match: default: false diff --git a/roles/keycloak_quarkus/README.md b/roles/keycloak_quarkus/README.md index 93e8efa..b104e23 100644 --- a/roles/keycloak_quarkus/README.md +++ b/roles/keycloak_quarkus/README.md @@ -88,7 +88,7 @@ Role Defaults |`keycloak_quarkus_systemd_wait_for_delay`| Activation delay for service systemd unit (seconds) | `10` | |`keycloak_quarkus_restart_strategy`| Strategy task file for restarting in HA (one of provided restart/['serial.yml','none.yml','serial_then_parallel.yml']) or path to file when providing custom strategy | `restart/serial.yml` | |`keycloak_quarkus_restart_health_check`| Whether to wait for successful health check after restart | `true` | -|`keycloak_quarkus_restart_health_check_delay`| Seconds to let pass before starting healch checks | `10` | +|`keycloak_quarkus_restart_health_check_delay`| Seconds to let pass before starting health checks | `10` | |`keycloak_quarkus_restart_health_check_retries`| Number of attempts for successful health check before failing | `25` | |`keycloak_quarkus_validate_certs`| Whether to validate SSL certificates when performing health checks | `true` | |`keycloak_quarkus_restart_pause`| Seconds to wait between restarts in HA strategy | `15` | diff --git a/roles/keycloak_quarkus/defaults/main.yml b/roles/keycloak_quarkus/defaults/main.yml index d0b466d..fc6bfdc 100644 --- a/roles/keycloak_quarkus/defaults/main.yml +++ b/roles/keycloak_quarkus/defaults/main.yml @@ -95,7 +95,7 @@ keycloak_quarkus_hostname: keycloak_quarkus_hostname_admin: "" ### Set the path relative to / for serving resources. The path must start with a / -### (set to `/auth` for retrocompatibility with pre-quarkus releases) +### (set to `/auth` for backward compatibility with pre-quarkus releases) keycloak_quarkus_http_relative_path: / # Disables dynamically resolving the hostname from request headers. diff --git a/roles/keycloak_quarkus/meta/argument_specs.yml b/roles/keycloak_quarkus/meta/argument_specs.yml index 2df7964..25f3e05 100644 --- a/roles/keycloak_quarkus/meta/argument_specs.yml +++ b/roles/keycloak_quarkus/meta/argument_specs.yml @@ -482,7 +482,7 @@ argument_specs: default: 15 type: int keycloak_quarkus_restart_health_check_delay: - description: "Seconds to let pass before starting healch checks" + description: "Seconds to let pass before starting health checks" default: 10 type: 'int' keycloak_quarkus_restart_health_check_retries: diff --git a/roles/keycloak_quarkus/tasks/restart/serial.yml b/roles/keycloak_quarkus/tasks/restart/serial.yml index 2ab5279..a596e53 100644 --- a/roles/keycloak_quarkus/tasks/restart/serial.yml +++ b/roles/keycloak_quarkus/tasks/restart/serial.yml @@ -1,5 +1,5 @@ --- -- name: "Restart services in serial, with optional healtch check (keycloak_quarkus_restart_health_check)" +- name: "Restart services in serial, with optional health check (keycloak_quarkus_restart_health_check)" throttle: 1 block: - name: "Restart and enable service: {{ keycloak.service_name }}" diff --git a/roles/keycloak_realm/defaults/main.yml b/roles/keycloak_realm/defaults/main.yml index 6de5faa..3afc20a 100644 --- a/roles/keycloak_realm/defaults/main.yml +++ b/roles/keycloak_realm/defaults/main.yml @@ -39,7 +39,7 @@ keycloak_realm_clients: [] # list of roles to create in the client keycloak_realm_client_default_roles: [] -# if True, create a public client; otherwise, a confidetial client +# if True, create a public client; otherwise, a confidential client keycloak_realm_client_public: true # allowed web origins for the client