Infrastructure updates

edaa-org · Nov 20, 2024 · 1884bb3 · 1884bb3
2 parents ca602c9 + 09d8e2f
commit 1884bb3
Show file tree

Hide file tree

Showing 34 changed files with 2,115 additions and 299 deletions.
diff --git a/.btd.yml b/.btd.yml
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,15 +1,29 @@
 version: 2
 updates:
-- package-ecosystem: pip
-  directory: "/"
-  target-branch: dev
-  commit-message:
-    prefix: "[Dependabot]"
-  labels:
+  # Maintain Python packages
+  - package-ecosystem: "pip"
+    directory: "/"
+    target-branch: dev
+    commit-message:
+      prefix: "[Dependabot]"
+    labels:
       - Dependencies
-  assignees:
-    - Paebbels
-  reviewers:
-    - Paebbels
-  schedule:
-    interval: daily
+    reviewers:
+      - Paebbels
+      - Umarcor
+    schedule:
+      interval: "daily"    # Checks on Monday trough Friday.
+
+  # Maintain GitHub Action runners
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: dev
+    commit-message:
+      prefix: "[Dependabot]"
+    labels:
+      - Dependencies
+    reviewers:
+      - Paebbels
+      - Umarcor
+    schedule:
+      interval: "weekly"
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,8 +1,30 @@
 # New Features
+
+* tbd
 * tbd
 
 # Changes
+
+* tbd
 * tbd
 
 # Bug Fixes
+
+* tbd
+* tbd
+
+# Documentation
+
+* tbd
+* tbd
+
+# Unit Tests
+
+* tbd
+* tbd
+
+----------
+# Related Issues and Pull-Requests
+
+* tbd
 * tbd
diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml
@@ -4,101 +4,15 @@ on:
   push:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * 5'
+# Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
+    - cron: '0 22 * * 5'
 
 jobs:
-
-  Params:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
-    with:
-      name: pyEDAA.OutputFilter
-
-#  UnitTesting:
-#    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r0
-#    needs:
-#      - Params
-#    with:
-#      jobs: ${{ needs.Params.outputs.python_jobs }}
-#      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}
-
-#  Coverage:
-#    uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@r0
-#    needs:
-#      - Params
-#    with:
-#      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
-#      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
-#    secrets:
-#      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
-
-#  PublishTestResults:
-#    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r0
-#    needs:
-#      - UnitTesting
-
-  Package:
-    uses: pyTooling/Actions/.github/workflows/Package.yml@r0
-    needs:
-      - Params
-      #- Coverage
+  Pipeline:
+    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r2
     with:
-      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
-      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
-
-  Release:
-    uses: pyTooling/Actions/.github/workflows/Release.yml@r0
-    if: startsWith(github.ref, 'refs/tags')
-    needs:
-      #- UnitTesting
-      #- Coverage
-      - Package
-
-  PublishOnPyPI:
-    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r0
-    if: startsWith(github.ref, 'refs/tags')
-    needs:
-      - Params
-      - Release
-      - Package
-    with:
-      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
-      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
+      package_namespace: pyEDAA
+      package_name: OutputFilter
     secrets:
-      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
-
-  BuildTheDocs:
-    uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
-    needs:
-      - Params
-    with:
-      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
-
-  PublishToGitHubPages:
-    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r0
-    needs:
-      - Params
-      - BuildTheDocs
-      #- Coverage
-    with:
-      doc: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
-      #coverage: ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
-
-  ArtifactCleanUp:
-    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r0
-    needs:
-      - Params
-      #- UnitTesting
-      #- PublishTestResults
-      #- Coverage
-      - BuildTheDocs
-      - PublishToGitHubPages
-    with:
-      package: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
-      remaining: |
-        ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
-#        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.6
-#        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.7
-#        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.8
-#        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.9
-#        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.10
-#        ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
+      PYPI_TOKEN:           ${{ secrets.PYPI_TOKEN }}
+      CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,13 @@ __pycache__/
 .coverage
 .cov
 coverage.xml
+/report/coverage
+
+# mypy
+/report/typing
+
+# pytest
+/report/unit
 
 # setuptools
 /build/**/*.*
@@ -21,5 +28,8 @@ coverage.xml
 /doc/pyEDAA.OutputFilter/**/*.*
 !/doc/pyEDAA.OutputFilter/index.rst
 
-# PyCharm project
+# PyCharm project files
 /.idea/workspace.xml
+
+# Git files
+!.git*
diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@
 [![Documentation](https://img.shields.io/website?longCache=true&style=flat-square&label=edaa-org.github.io%2FpyEDAA.OutputFilter&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2Fedaa-org.github.io%2FpyEDAA.OutputFilter%2Findex.html)](https://edaa-org.github.io/pyEDAA.OutputFilter/)
 [![Gitter](https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef)](https://gitter.im/hdl/community)  
 [![GitHub Workflow - Build and Test Status](https://img.shields.io/github/workflow/status/edaa-org/pyEDAA.OutputFilter/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://GitHub.com/edaa-org/pyEDAA.OutputFilter/actions/workflows/Pipeline.yml)
+[![Codacy - Quality](https://img.shields.io/codacy/grade/4918480c41594ffbb62f8ff98433b800?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.OutputFilter)
 
 <!--
 [![Sourcecode License](https://img.shields.io/pypi/l/pyEDAA.OutputFilter?longCache=true&style=flat-square&logo=Apache&label=code)](LICENSE.md)
@@ -16,8 +17,7 @@
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyEDAA.OutputFilter?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
 
 [![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyEDAA.OutputFilter?longCache=true&style=flat-square&logo=Libraries.io&logoColor=fff)](https://libraries.io/github/edaa-org/pyEDAA.OutputFilter)
-[![Codacy - Quality](https://img.shields.io/codacy/grade/39d312bf98244961975559f141c3e000?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.OutputFilter)
-[![Codacy - Coverage](https://img.shields.io/codacy/coverage/39d312bf98244961975559f141c3e000?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.OutputFilter)
+[![Codacy - Coverage](https://img.shields.io/codacy/coverage/4918480c41594ffbb62f8ff98433b800?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.OutputFilter)
 [![Codecov - Branch Coverage](https://img.shields.io/codecov/c/github/edaa-org/pyEDAA.OutputFilter?longCache=true&style=flat-square&logo=Codecov)](https://codecov.io/gh/edaa-org/pyEDAA.OutputFilter)
 
 [![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/pyEDAA.OutputFilter?longCache=true&style=flat-square&logo=GitHub)](https://GitHub.com/edaa-org/pyEDAA.OutputFilter/network/dependents)
@@ -31,7 +31,7 @@
 
 # Main Goals
 
-* Read text outputs from CLI of EDA tools.
+* Analyze text outputs from CLI of EDA tools.
 * Filter and categorize by severity (*info*, *warning*, *error*, *fatal*, ...).
 * Extract information from e.g. OSVVM logs, VUnit logs, ...
 

diff --git a/dist/requirements.txt b/dist/requirements.txt
@@ -1,2 +1,2 @@
-wheel
-twine
+wheel ~= 0.45
+twine ~= 5.1