Dev to master

.github/workflows/code-coverage.yml

@@ -0,0 +1,41 @@
+name: Code Coverage Analysis
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+    branches:
+      - develop
+    types:
+      - opened
+      - edited
+      - reopened
+      - synchronize
+      - unlocked
+
+jobs:
+  codecov:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          python generate_requirements.py
+          pip install --upgrade pip setuptools wheel
+          pip install -r requirements-dev.txt
+      - name: Run test and generate coverage report
+        run: |
+          pip install pytest-cov
+          pip install codecov
+          pytest --cov=./ --cov-report=xml
+      - name: Upload coverage information to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          version: "v0.2.6"
+          fail_ci_if_error: true # optional (default = false)
+          verbose: true # optional (default = false)

.github/workflows/main.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: stix-shifter
+name: CI Build
 
 on: [push, pull_request]
 
@@ -14,11 +14,13 @@ jobs:
         python-version: [3.8, 3.9]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+        cache-dependency-path: '**/requirements-dev.txt'
     - name: Install dependencies
       run: |
         python generate_requirements.py
@@ -31,14 +33,7 @@ jobs:
         flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics
         # exit-zero treats all errors as warnings.  The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Run test and generate coverage report
+    - name: Run unittest
       run: |
         pip install pytest
-        pip install pytest-cov
-        pip install codecov
-        pytest --cov=./ --cov-report=xml
-    - name: Upload coverage information to Codecov
-      uses: codecov/codecov-action@v1
-      with:
-        fail_ci_if_error: true # optional (default = false)
-        verbose: true # optional (default = false)
+        pytest -vv

.gitignore

@@ -59,7 +59,7 @@ coverage.xml
 
 # virtualenv
 .venv
-venv/
+venv*/
 ENV/
 virtualenv*/
 labenv/

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+   - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt