Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix spelling issues + fix reported issues #274

Merged
merged 5 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -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
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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*.

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
4 changes: 2 additions & 2 deletions tests/tests_runtime_directory.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
Expand Down
Loading