From e989470028c1dcfe14bc7a802fb51938852821fb Mon Sep 17 00:00:00 2001 From: Jakub Jelen Date: Fri, 26 Jan 2024 16:15:01 +0100 Subject: [PATCH 1/5] README: Fix double-the in documentation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d423bce8..9da149fe 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ the `sshd_service` variable. #### sshd_manage_firewall -If set to *true*, the the SSH port(s) will be opened in firewall. Note, this +If set to *true*, the SSH port(s) will be opened in firewall. Note, this works only on Red Hat based OS. The default is *false*. NOTE: `sshd_manage_firewall` is limited to *adding* ports. It cannot be used @@ -122,7 +122,7 @@ firewall system role directly. #### sshd_manage_selinux -If set to *true*, the the selinux will be configured to allow sshd listening +If set to *true*, the selinux will be configured to allow sshd listening on the given SSH port(s). Note, this works only on Red Hat based OS. The default is *false*. From edf383cd6071e466e7f645aeea0b54e1b429b7a0 Mon Sep 17 00:00:00 2001 From: Jakub Jelen Date: Fri, 26 Jan 2024 16:16:39 +0100 Subject: [PATCH 2/5] README: Consistently referer to the role name and not to repository name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9da149fe..4d909838 100644 --- a/README.md +++ b/README.md @@ -424,7 +424,7 @@ option: tasks: - name: Configure sshd to accept some useful environment variables include_role: - name: ansible-sshd + name: willshersystems.sshd vars: sshd_config_namespace: accept-env sshd: From 6e325b9f1d43238e4707a92f05f98042268280dd Mon Sep 17 00:00:00 2001 From: Jakub Jelen Date: Fri, 26 Jan 2024 16:34:07 +0100 Subject: [PATCH 3/5] README: Improve wording --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4d909838..9d06d871 100644 --- a/README.md +++ b/README.md @@ -233,8 +233,8 @@ non-conflicting options from different roles invocations. #### sshd_config_owner, sshd_config_group, sshd_config_mode -Use these variables to set the ownership and permissions for the openssh config -file that this role produces. +Use these variables to set the ownership and permissions for the openssh +configuration file that this role produces. #### sshd_verify_hostkeys From 4f10b450dfbc6eea77d59ba3b69b9a283728ccf1 Mon Sep 17 00:00:00 2001 From: Jakub Jelen Date: Fri, 26 Jan 2024 16:39:54 +0100 Subject: [PATCH 4/5] Fix more typos --- README.md | 4 ++-- contributing.md | 2 +- tests/tests_runtime_directory.yml | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9d06d871..825cfeeb 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ for AIX) #### sshd_allow_reload -If set to *false*, a reload of sshd wont happen on change. This can help with +If set to *false*, a reload of sshd won't happen on change. This can help with troubleshooting. You'll need to manually reload sshd if you want to apply the changed configuration. Defaults to the same value as `sshd_manage_service`. (Except on AIX, where `sshd_manage_service` is default *false*, but @@ -451,7 +451,7 @@ More example playbooks can be found in [`examples/`](examples/) directory. The [`sshd_config.j2`](templates/sshd_config.j2) and [`sshd_config_snippet.j2`](templates/sshd_config_snippet.j2) templates are -programatically generated by the scripts in meta. New options should be added +programmatically generated by the scripts in meta. New options should be added to the `options_body` and/or `options_match`. To regenerate the templates, from within the `meta/` directory run: diff --git a/contributing.md b/contributing.md index 9bda83fe..b6770ed9 100644 --- a/contributing.md +++ b/contributing.md @@ -47,7 +47,7 @@ You must use automation to create releases consistently. The process of creating This script creates updates CHANGELOG.md with a summary of pull requests added since the previous release and with automatically identified new version based on the PR types. It also optionally updates .README.html with changes to README.md made since the previous release. - To learn more about available script options, see [role-make-version-changelog.sh documantation](https://github.com/linux-system-roles/auto-maintenance#role-make-version-changelogsh). + To learn more about available script options, see [role-make-version-changelog.sh documentation](https://github.com/linux-system-roles/auto-maintenance#role-make-version-changelogsh). 4. Verify that the script added a commit for new release by running `git log`. diff --git a/tests/tests_runtime_directory.yml b/tests/tests_runtime_directory.yml index 291a0456..1d6a5f8c 100644 --- a/tests/tests_runtime_directory.yml +++ b/tests/tests_runtime_directory.yml @@ -21,7 +21,7 @@ vars: sshd_install_service: true - - name: Verify the runtime diretory is created on Debian + - name: Verify the runtime directory is created on Debian tags: tests::verify when: - ansible_facts['os_family'] == "Debian" @@ -96,7 +96,7 @@ - '"RuntimeDirectory=" not in service_inst.content | b64decode' - '"RuntimeDirectoryMode=" not in service_inst.content | b64decode' - - name: Verify the runtime diretory is not created in wrong places + - name: Verify the runtime directory is not created in wrong places tags: tests::verify block: - name: Stat the home directory for the runtime directory From 336954c14bc1d4a44100a8773e039d38e81c4021 Mon Sep 17 00:00:00 2001 From: Jakub Jelen Date: Fri, 26 Jan 2024 16:40:21 +0100 Subject: [PATCH 5/5] ci: Add GH action to check for spelling mistakes --- .github/workflows/codespell.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/workflows/codespell.yml diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 00000000..6c2d92d0 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,18 @@ +--- +name: Codespell + +on: + pull_request: + push: + +permissions: + contents: read # to fetch code (actions/checkout) + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - uses: codespell-project/actions-codespell@master