Skip to content

Commit

Permalink
add spellchecking with codespell (#79)
Browse files Browse the repository at this point in the history
* add codespell action

Signed-off-by: Martin Schurz <[email protected]>

* fix spelling errors

Signed-off-by: Martin Schurz <[email protected]>

---------

Signed-off-by: Martin Schurz <[email protected]>
  • Loading branch information
schurzi authored May 2, 2023
1 parent 9d2ad8f commit 7970dfa
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
12 changes: 12 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Codespell - Spellcheck

on: # yamllint disable-line rule:truthy
push:
branches: [master]
pull_request:
branches: [master]

jobs:
codespell:
uses: "dev-sec/.github/.github/workflows/codespell.yml@main"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ We use a yml attribute file to steer the configuration, the following options ar
* `benchmark_version`
to execute also the old controls from previous benchmarks, e.g. set it to 1.12.0 to execute also the tests from cis-benchmark-1.12.0 (which is the default).

These settings can be overriden using an attributes file (e.g. --attrs <attributefile.yml>). See [sample_attributes.yml](sample_attributes.yml) as an example.
These settings can be overridden using an attributes file (e.g. --attrs <attributefile.yml>). See [sample_attributes.yml](sample_attributes.yml) as an example.

## Usage

Expand Down
6 changes: 3 additions & 3 deletions controls/docker_daemon_configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
tag 'cis-docker-1.12.0': '2.6'
tag 'cis-docker-1.13.0': '2.6'
tag 'level:1'
ref 'Protect Docker deamon socket', url: 'https://docs.docker.com/engine/security/https/'
ref 'Protect Docker daemon socket', url: 'https://docs.docker.com/engine/security/https/'

describe json('/etc/docker/daemon.json') do
its(['tls']) { should eq(true) }
Expand All @@ -164,7 +164,7 @@
tag 'cis-docker-1.12.0': '2.7'
tag 'cis-docker-1.13.0': '2.7'
tag 'level:1'
ref 'Docker daemon deafult ulimits', url: 'https://docs.docker.com/engine/reference/commandline/daemon/#default-ulimits'
ref 'Docker daemon default ulimits', url: 'https://docs.docker.com/engine/reference/commandline/daemon/#default-ulimits'

describe json('/etc/docker/daemon.json') do
its(%w(default-ulimits nproc)) { should eq('1024:2408') }
Expand Down Expand Up @@ -344,7 +344,7 @@
title 'Control the number of manager nodes in a swarm'
desc 'Ensure that the minimum number of required manager nodes is created in a swarm.
Rationale: Manager nodes within a swarm have control over the swarm and change its configuration modifying security parameters. Having excessive manager nodes could render the swarm more susceptible to compromise. If fault tolerance is not required in the manager nodes, a single node should be elected as a manger. If fault tolerance is required then the smallest practical odd number to achieve the appropriate level of tolerance should be configured.'
Rationale: Manager nodes within a swarm have control over the swarm and change its configuration modifying security parameters. Having excessive manager nodes could render the swarm more susceptible to compromise. If fault tolerance is not required in the manager nodes, a single node should be elected as a manager. If fault tolerance is required then the smallest practical odd number to achieve the appropriate level of tolerance should be configured.'

tag 'docker'
tag 'cis-docker-1.12.0': '2.16'
Expand Down

0 comments on commit 7970dfa

Please sign in to comment.