Merge pull request #75 from usnistgov/structure-oscal-content

Structure oscal content into develop branch

.github/workflows/generate_leveraged.yaml

@@ -9,21 +9,26 @@ on:
   pull_request: {}
 jobs:
   partial_ssp:
+
     runs-on: ubuntu-20.04
     defaults:
       run:
         working-directory: .
     steps:
+
       - name: Check out repository code.
         uses: actions/checkout@v3
+
       - uses: actions/setup-python@v4
         with:
           python-version: '3.10' 
+
       - name: Check environment.
         run: |
           ls -ltra
           python --version
           pip --version
+
       - name: Install dependencies.
         run: |
           pip install -r requirements.txt
@@ -33,6 +38,7 @@ jobs:
       - name: Execute script.
         run: |
           python oscal_leveraged.py
+
       - name: Save SSP.
         uses: actions/upload-artifact@v3
         with:

.github/workflows/generate_ssp.yaml

@@ -7,37 +7,48 @@ on:
       - develop
       - main
   pull_request: {}
+
 jobs:
+
   partial_ssp:
     runs-on: ubuntu-20.04
+
     defaults:
       run:
         working-directory: .
+
     steps:
-      - name: Check out repository code.
+      - name: Check-Out Repository Code into Virtual Environment.
         uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+
+      - name: Perform Python SetUp in the Virtual Environment.   
+        uses: actions/setup-python@v4
         with:
-          python-version: '3.10' 
-      - name: Check environment.
+          python-version: '3.11' 
+
+      - name: Post-SetUp Virtual Environment Checkup.
         run: |
           ls -ltra
           python --version
           pip --version
+
       - name: Install dependencies.
         run: |
           pip install -r requirements.txt
       # - name: Run tests.
       #   run: |
       #     pytest
+
       - name: Execute script.
         run: |
           python oscal.py
+
       - name: Save SSP.
         uses: actions/upload-artifact@v3
         with:
           name: artifact-ssp
           path: SSP.output.yaml
+
   validate_oscal:
     runs-on: ubuntu-20.04
     if: ${{ github.ref_name == 'main' || github.ref_name == 'develop' || github.ref_name == 'feature-doc-templates' }}
@@ -47,20 +58,24 @@ jobs:
       - name: Checkout
         uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
         id: checkout
+
       - name: Setup Java
         uses: actions/setup-java@c3ac5dd0ed8db40fedb61c32fbe677e6b355e94c
         with:
           distribution: adopt
           java-version: 11
+
       - name: Download SSP.
         uses: actions/download-artifact@v3
         with:
           name: artifact-ssp
+
       - name: Run oscal-cli Validation.
         uses: oscal-club/[email protected]
         id: validation
         with:
           args: ssp validate SSP.output.yaml
+
       - name: Validation Result
         shell: bash
         run: |

.gitignore

@@ -1,5 +1,11 @@
 .DS_Store
+.vscode/*
 *.pyc
 __pycache__/
 draft-*
-*.output.*
+*.output.*
+# Ignore virtual environments
+.venv*
+.pyenv*
+.env*
+oscal-cli.txt

README.md

@@ -1,2 +1,15 @@
 # blossom-oscal
 OSCAL content that supports the BloSS@M project.
+
+
+## Using local git-actions with NEKTOS/ACT
+- BASH is preferred by ACT as zsh has some known issues
+- Specify DOCKER_HOST location for Rancher or other alternative containerization tool. It informs Nektos/ACT to use current DOCKER_HOST in non-Docker configuration on MacOS. Alternative OS Guidance can be found [here](https://nektosact.com/usage/custom_engine.html)
+```
+export DOCKER_HOST=$(docker context inspect --format '{{.Endpoints.docker.Host}}') 
+```
+
+- To list actions available:
+  ```
+  act -l
+  ```