Skip to content

Commit 7970dfa

Browse files
authored
add spellchecking with codespell (#79)
* 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]>
1 parent 9d2ad8f commit 7970dfa

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

.github/workflows/codespell.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: Codespell - Spellcheck
3+
4+
on: # yamllint disable-line rule:truthy
5+
push:
6+
branches: [master]
7+
pull_request:
8+
branches: [master]
9+
10+
jobs:
11+
codespell:
12+
uses: "dev-sec/.github/.github/workflows/codespell.yml@main"

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ We use a yml attribute file to steer the configuration, the following options ar
6464
* `benchmark_version`
6565
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).
6666

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

6969
## Usage
7070

controls/docker_daemon_configuration.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
tag 'cis-docker-1.12.0': '2.6'
143143
tag 'cis-docker-1.13.0': '2.6'
144144
tag 'level:1'
145-
ref 'Protect Docker deamon socket', url: 'https://docs.docker.com/engine/security/https/'
145+
ref 'Protect Docker daemon socket', url: 'https://docs.docker.com/engine/security/https/'
146146

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

169169
describe json('/etc/docker/daemon.json') do
170170
its(%w(default-ulimits nproc)) { should eq('1024:2408') }
@@ -344,7 +344,7 @@
344344
title 'Control the number of manager nodes in a swarm'
345345
desc 'Ensure that the minimum number of required manager nodes is created in a swarm.
346346
347-
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.'
347+
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.'
348348

349349
tag 'docker'
350350
tag 'cis-docker-1.12.0': '2.16'

0 commit comments

Comments
 (0)