From 1c28564954f73742e4b066222fe305f35268bb19 Mon Sep 17 00:00:00 2001 From: Frederick Witty Date: Tue, 26 Sep 2023 13:17:26 -0400 Subject: [PATCH] Typo fixes-1 Signed-off-by: Frederick Witty --- .../workflows/devel_pipeline_validation.yml | 18 +++++++++--------- .github/workflows/main_pipeline_validation.yml | 14 +++++++------- .github/workflows/update_galaxy.yml | 6 +----- .yamllint | 1 + CONTRIBUTING.rst | 16 ++++++++-------- README.md | 12 ++++++------ 6 files changed, 32 insertions(+), 35 deletions(-) diff --git a/.github/workflows/devel_pipeline_validation.yml b/.github/workflows/devel_pipeline_validation.yml index dba39dc0..040dbf2d 100644 --- a/.github/workflows/devel_pipeline_validation.yml +++ b/.github/workflows/devel_pipeline_validation.yml @@ -17,7 +17,7 @@ # A workflow run is made up of one or more jobs # that can run sequentially or in parallel jobs: - # This will create messages for first time contributers and direct them to the Discord server + # This will create messages for first-time contributors and direct them to the Discord server welcome: runs-on: ubuntu-latest @@ -29,13 +29,13 @@ Congrats on opening your first pull request and thank you for taking the time to help improve Ansible-Lockdown! Please join in the conversation happening on the [Discord Server](https://www.lockdownenterprise.com/discord) as well. - # This workflow contains a single job which tests the playbook + # This workflow contains a single job that tests the playbook playbook-test: # The type of runner that the job will run on runs-on: ubuntu-latest env: ENABLE_DEBUG: ${{ vars.ENABLE_DEBUG }} - # Imported as a variable by terraform + # Imported as a variable by Terraform TF_VAR_repository: ${{ github.event.repository.name }} defaults: run: @@ -48,7 +48,7 @@ with: ref: ${{ github.event.pull_request.head.sha }} - # Pull in terraform code for linux servers + # Pull in Terraform code for Linux servers - name: Clone github IaC plan uses: actions/checkout@v3 with: @@ -74,7 +74,7 @@ pwd ls env: - # Imported from github variables this is used to load the relvent OS.tfvars file + # Imported from GitHub variables this is used to load the relevant OS.tfvars file OSVAR: ${{ vars.OSVAR }} benchmark_type: ${{ vars.BENCHMARK_TYPE }} @@ -82,7 +82,7 @@ id: init run: terraform init env: - # Imported from github variables this is used to load the relvent OS.tfvars file + # Imported from GitHub variables this is used to load the relevant OS.tfvars file OSVAR: ${{ vars.OSVAR }} TF_VAR_benchmark_type: ${{ vars.BENCHMARK_TYPE }} @@ -90,7 +90,7 @@ id: validate run: terraform validate env: - # Imported from github variables this is used to load the relvent OS.tfvars file + # Imported from GitHub variables this is used to load the relevant OS.tfvars file OSVAR: ${{ vars.OSVAR }} TF_VAR_benchmark_type: ${{ vars.BENCHMARK_TYPE }} @@ -108,12 +108,12 @@ if: env.ENABLE_DEBUG == 'true' run: cat hosts.yml - # Aws deployments taking a while to come up insert sleep or playbook fails + # AWS deployments taking a while to come up insert sleep or playbook fails - name: Sleep for 60 seconds run: sleep 60s - # Run the ansible playbook + # Run the Ansible playbook - name: Run_Ansible_Playbook uses: arillso/action.playbook@master with: diff --git a/.github/workflows/main_pipeline_validation.yml b/.github/workflows/main_pipeline_validation.yml index 0b149fb3..976f9b79 100644 --- a/.github/workflows/main_pipeline_validation.yml +++ b/.github/workflows/main_pipeline_validation.yml @@ -18,7 +18,7 @@ # that can run sequentially or in parallel jobs: - # This workflow contains a single job which tests the playbook + # This workflow contains a single job that tests the playbook playbook-test: # The type of runner that the job will run on runs-on: ubuntu-latest @@ -37,8 +37,8 @@ with: ref: ${{ github.event.pull_request.head.sha }} - # Pull in terraform code for linux servers - - name: Clone github IaC plan + # Pull in Terraform code for Linux servers + - name: Clone GitHub IaC plan uses: actions/checkout@v3 with: repository: ansible-lockdown/github_linux_IaC @@ -63,7 +63,7 @@ pwd ls env: - # Imported from github variables this is used to load the relvent OS.tfvars file + # Imported from GitHub variables this is used to load the relevant OS.tfvars file OSVAR: ${{ vars.OSVAR }} benchmark_type: ${{ vars.BENCHMARK_TYPE }} @@ -71,7 +71,7 @@ id: init run: terraform init env: - # Imported from github variables this is used to load the relvent OS.tfvars file + # Imported from GitHub variables this is used to load the relevant OS.tfvars file OSVAR: ${{ vars.OSVAR }} TF_VAR_benchmark_type: ${{ vars.BENCHMARK_TYPE }} @@ -79,7 +79,7 @@ id: validate run: terraform validate env: - # Imported from github variables this is used to load the relvent OS.tfvars file + # Imported from GitHub variables this is used to load the relevant OS.tfvars file OSVAR: ${{ vars.OSVAR }} TF_VAR_benchmark_type: ${{ vars.BENCHMARK_TYPE }} @@ -102,7 +102,7 @@ - name: Sleep for 60 seconds run: sleep 60s - # Run the ansible playbook + # Run the Ansible playbook - name: Run_Ansible_Playbook uses: arillso/action.playbook@master with: diff --git a/.github/workflows/update_galaxy.yml b/.github/workflows/update_galaxy.yml index 2052b0a8..e46092b0 100644 --- a/.github/workflows/update_galaxy.yml +++ b/.github/workflows/update_galaxy.yml @@ -1,12 +1,8 @@ --- -# This is a basic workflow to help you get started with Actions - name: update galaxy -# Controls when the action will run. -# Triggers the workflow on merge request events to the main branch -on: # yamllint disable-line rule:truthy +on: push: branches: - main diff --git a/.yamllint b/.yamllint index 65faae6c..db1b7584 100755 --- a/.yamllint +++ b/.yamllint @@ -1,4 +1,5 @@ --- + extends: default ignore: | diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1680d197..2a7fd388 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -5,11 +5,11 @@ Rules ----- 1) All commits must be GPG signed (details in Signing section) 2) All commits must have Signed-off-by (Signed-off-by: Joan Doe ) in the commit message (details in Signing section) -3) All work is done in your own branch or own fork +3) All work is done in your own branch or fork 4) Pull requests - a) From within the repo: All pull requests go into the devel branch. There are automated checks for signed commits, signoff in commit message, and functional testing - b) From a forked repo: All pull requests will go into a staging branch within the repo. There are automated checks for signed commits, signoff in commit message, and functional testing when going from staging to devel -4) All pull requests go into the devel branch. There are automated checks for signed commits, signoff in commit message, and functional testing) + a) From within the repo: All pull requests go into the devel branch. There are automated checks for signed commits, signoff in commit messages, and functional testing + b) From a forked repo: All pull requests will go into a staging branch within the repo. There are automated checks for signed commits, signoff in commit messages, and functional testing when going from staging to devel +4) All pull requests go into the devel branch. There are automated checks for signed commits, signoff in commit messages, and functional testing) 5) Be open and nice to each other Workflow @@ -32,19 +32,19 @@ The process is to certify the below DCO 1.1 text By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license + have the right to submit it under the open-source license indicated in the file; or (b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source + of my knowledge, is covered under an appropriate open-source license and I have the right under that license to submit that work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am + by me, under the same open-source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified + person who certified (a), (b), or (c) and I have not modified it. (d) I understand and agree that this project and the contribution diff --git a/README.md b/README.md index c65b7b27..188493eb 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Join us on our [Discord Server](https://www.lockdownenterprise.com/discord) to a This role **will make changes to the system** that could break things. This is not an auditing tool but rather a remediation tool to be used after an audit has been conducted. -This role was developed against a clean install of the Operating System. If you are implementing to an existing system please review this role for any site specific changes that are needed. +This role was developed against a clean install of the Operating System. If you are implementing on an existing system, please review this role for any site-specific changes that are needed. ## Documentation @@ -64,7 +64,7 @@ This role was developed against a clean install of the Operating System. If you - [Tower User Guide](https://docs.ansible.com/ansible-tower/latest/html/userguide/index.html) - [Ansible Community Info](https://docs.ansible.com/ansible/latest/community/index.html) - Functioning Ansible and/or Tower Installed, configured, and running. This includes all of the base Ansible/Tower configurations, needed packages installed, and infrastructure setup. -- Please read through the tasks in this role to gain an understanding of what each control is doing. Some of the tasks are disruptive and can have unintended consequences in a live production system. Also familiarize yourself with the variables in the defaults/main.yml file or the [Main Variables Wiki Page](https://github.com/ansible-lockdown/UBUNTU22-CIS/wiki/Main-Variables). +- Please read through the tasks in this role to gain an understanding of what each control is doing. Some of the tasks are disruptive and can have unintended consequences in a live production system. Also, familiarize yourself with the variables in the defaults/main.yml file or the [Main Variables Wiki Page](https://github.com/ansible-lockdown/UBUNTU22-CIS/wiki/Main-Variables). **Technical Dependencies:** @@ -87,14 +87,14 @@ Further audit documentation can be found at [Read The Docs](https://ansible-lock ## Role Variables -This role is designed that the end user should not have to edit the tasks themselves. All customizing should be done via the defaults/main.yml file or with extra vars within the project, job, workflow, etc. +This role is designed so the end user should not have to edit the tasks themselves. All customizing should be done via the defaults/main.yml file or with extra vars within the project, job, workflow, etc. ## Branches -- **devel** - This is the default branch and the working development branch. Community pull requests will pull into this branch +- **devel** - This is the default branch and the working development branch. Community pull requests will be pulled into this branch - **main** - This is the release branch - **reports** - This is a protected branch for our scoring reports, no code should ever go here -- **gh-pages** - This is the github pages branch +- **gh-pages** - This is the GitHub pages branch - **all other branches** - Individual community member branches ## Community Contribution @@ -111,7 +111,7 @@ We encourage you (the community) to contribute to this role. Please read the rul uses: - ansible-core 2.12 -- ansible collections - pulls in the latest version based on requirements file +- ansible collections - pulls in the latest version based on the requirements file - runs the audit using the devel branch - This is an automated test that occurs on pull requests into devel