Merge pull request #19 from edwardtheharris/18-enable-execution-on-fr…

…esh-installs

Add missing steps

Closes #18

Update test files

Closes #17

Update name

Closes #17

Update workflows

Closes #17

Update pipfile lock

Closes #17

Update workflows

Closes #17

Update docs

Closes #17

Update badges

Closes #17

Update readmne

Closes #17

.github/index.md

@@ -0,0 +1,69 @@
+---
+abstract: Continuous Integration, Deployment, and Delivery guide.
+authors:
+    - name: Xander Harris
+      email: [email protected]
+date: 2024-08-11
+title: CI/CD guide
+---
+
+Or something like it.
+
+## Workflows
+
+The following GitHub Action workflows run in this repository.
+
+### Ansible Workflow
+
+[![ansible-lint](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/ansible.yml/badge.svg)](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/ansible.yml)
+<!--
+
+```{autoyaml} .github/workflows/ansible.yml
+```
+-->
+
+### CodeQL Workflow
+
+[![CodeQL](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/codeql.yml/badge.svg)](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/codeql.yml)
+
+<!--
+```{autoyaml} .github/workflows/codeql.yml
+```
+-->
+### Documentation Workflow
+
+[![Documentation](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/documentation.yml/badge.svg)](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/documentation.yml)
+
+<!--
+```{autoyaml} .github/workflows/documentation.yml
+```
+-->
+
+### OSSAR Workflow
+
+[![OSSAR](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/ossar.yml/badge.svg)](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/ossar.yml)
+
+<!--
+```{autoyaml} .github/workflows/ossar.yml
+```
+-->
+
+### Shell Check Workflow
+
+[![ShellCheck](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/shell.yml/badge.svg)](https://github.com/edwardtheharris/ansible-kcp/actions/workflows/shell.yml)
+
+<!--
+```{autoyaml} .github/workflows/shell.yml
+```
+-->
+
+## Dependabot
+
+```{literalinclude} /.github/dependabot.yml
+:language: yaml
+```
+
+<!--
+```{autoyaml} .github/dependabot.yml
+```
+-->

.github/workflows/ansible.yml

@@ -4,11 +4,7 @@
 # ---
 # This action lints Ansible code for quality.
 #
-# ```{literalinclude} .github/workflows/ansible-lint.yml
-# :language: yaml
-# :caption: .github/workflows/ansible-lint.yml
-# ```
-name: ansible-lint
+name: Ansible Lint
 on:
   pull_request:
     branches: ["main", "stable", "release/v*"]

.github/workflows/codeql.yml

@@ -14,7 +14,7 @@
 # supported CodeQL languages.
 # ```
 #
-# ```{literalinclude} ./.github/workflows/codeql.yml
+# ```{literalinclude} /.github/workflows/codeql.yml
 # :caption: .github/workflows/codeql.yml#name
 # :language: yaml
 # :start-at: "name: CodeQL\n"
@@ -34,7 +34,7 @@ on:
 # ---
 # Define the jobs that run in the CodeQL workflow.
 #
-# ```{literalinclude} ./.github/workflows/codeql.yml
+# ```{literalinclude} /.github/workflows/codeql.yml
 # :caption: .github/workflows/codeql.yml#jobs
 # :language: yaml
 # :start-at: "jobs:\n"

.github/workflows/pages.yml → .github/workflows/documentation.yml

@@ -11,7 +11,7 @@
 # ```
 #
 # Set a name for the workflow.
-name: Test, Build, Deploy to GitHub Pages
+name: Documentation
 on:
   push:
     branches:

.github/workflows/ossar.yml

@@ -0,0 +1,88 @@
+###
+# ```{rubric} OSSAR
+# ```
+# ---
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+#
+# This workflow integrates a collection of open source static analysis tools
+# with GitHub code scanning. For documentation, or to provide feedback, visit
+# https://github.com/github/ossar-action
+#
+# ```{literalinclude} /.github/workflows/ossar.yml
+# :language: yaml
+# :start-at: "name: OSSAR\n"
+# :end-before: "###\n"
+# ```
+name: OSSAR
+permissions:
+  contents: read
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    ###
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '43 10 * * 4'
+
+###
+# ```{rubric} OSSAR Jobs
+# ```
+# ---
+# Define the jobs necessary for a useful ossar run.
+#
+# ```{literalinclude} /.github/workflows/ossar.yml
+# :language: yaml
+# :start-at: "jobs:\n"
+# ```
+jobs:
+  OSSAR-Scan:
+    ###
+    # OSSAR runs on windows-latest.
+    # ubuntu-latest and macos-latest support coming soon
+    permissions:
+      ###
+      # for actions/checkout to fetch code
+      contents: read
+      ###
+      # for github/codeql-action/upload-sarif to upload SARIF results
+      security-events: write
+      ###
+      # only required for a private repository by
+      # github/codeql-action/upload-sarif to get the Action run status
+      actions: read
+    runs-on: windows-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@main
+    ###
+    # Ensure a compatible version of dotnet is installed.
+    # The [Microsoft Security Code Analysis CLI](https://aka.ms/mscadocs)
+    # is built with dotnet v3.1.201.
+    # A version greater than or equal to v3.1.201 of dotnet must be installed
+    # on the agent in order to run this action.
+    # GitHub hosted runners already have a compatible version of dotnet
+    # installed and this step may be skipped.
+    # For self-hosted runners, ensure dotnet version 3.1.201 or later is
+    # installed by including this action:
+    # ```{code-block} yaml
+    # - name: Install .NET
+    #   uses: actions/setup-dotnet@v2
+    #   with:
+    #     dotnet-version: '3.1.x'
+    # ```
+    #
+    # Run open source static analysis tools
+    - name: Run OSSAR
+      uses: github/ossar-action@main
+      id: ossar
+      ###
+      # Upload results to the Security tab
+    - name: Upload OSSAR results
+      uses: github/codeql-action/upload-sarif@main
+      with:
+        sarif_file: ${{ steps.ossar.outputs.sarifFile }}

Pipfile

@@ -12,7 +12,6 @@ gitpython = "*"
 loguru = "*"
 pipenv = "*"
 redis = "*"
-sphinxcontrib-yaml = "*"
 
 [dev-packages]
 ansible-lint = "*"
@@ -39,4 +38,6 @@ sphinx-togglebutton = "*"
 sphinxcontrib-autoyaml = "*"
 sphinxemoji = "*"
 sphinxext-opengraph = "*"
-sphinxext-rediraffe = "*"
+
+[pipenv]
+allow_prereleases = true