Initial Commit - Forked from PeakRDL-regblock @ a440cc19769069be831d267505da4f3789a26695

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: The tool is not doing what I expected
+title: "[BUG]"
+labels: ''
+assignees: ''
+
+---
+
+- [ ] I have reviewed this project's [contribution guidelines](https://github.com/SystemRDL/PeakRDL-regblock/blob/main/CONTRIBUTING.md)
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+Details like these can be helpful:
+* Sample SystemRDL code
+* Error message, simulation waveform, etc.
+* Version numbers for the tool, Python, and OS
+
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]"
+labels: ''
+assignees: ''
+
+---
+
+- [ ] I have reviewed this project's [contribution guidelines](https://github.com/SystemRDL/PeakRDL-regblock/blob/main/CONTRIBUTING.md)
+
+**Describe the problem/limitation you think should be addressed**
+A clear and concise description of what the problem is.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or about the feature request here.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,10 @@
+---
+name: Question
+about: I have a question
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Please consider using the discussion board for more open-ended questions: https://github.com/orgs/SystemRDL/discussions

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+# Description of change
+
+Describe what bug or feature your pull request addresses.
+If applicable, provide a link to the relevant issue ticket or discussion about
+this change.
+
+# Checklist
+
+- [ ] I have reviewed this project's [contribution guidelines](https://github.com/SystemRDL/PeakRDL-regblock/blob/main/CONTRIBUTING.md)
+- [ ] This change has been tested and does not break any of the existing unit tests. (if unable to run the tests, let us know)
+- [ ] If this change adds new features, I have added new unit tests that cover them.

.github/workflows/build.yml

@@ -0,0 +1,178 @@
+name: build
+
+on:
+  push:
+    branches:
+      - main
+      - 'dev/**'
+  pull_request:
+    branches: [ main ]
+  release:
+    types:
+      - published
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        python-version:
+          - "3.7"
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+        include:
+          - os: ubuntu-latest
+
+          # older versions need older OS
+          - python-version: "3.7"
+            os: ubuntu-22.04
+
+          - python-version: "3.8"
+            os: ubuntu-22.04
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -r tests/requirements.txt
+
+      - name: Install
+        run: |
+          python -m pip install ".[cli]"
+
+      - name: Test
+        run: |
+          cd tests
+          pytest --cov=peakrdl_regblock --synth-tool skip --sim-tool stub
+
+      - name: Coveralls
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_PARALLEL: true
+        run: |
+          cd tests
+          coveralls --service=github
+
+  finish_coveralls:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: Coveralls
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_PARALLEL: true
+        run: |
+          python -m pip install coveralls>=3.0.0
+          coveralls --service=github --finish
+
+#-------------------------------------------------------------------------------
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -r tests/requirements.txt
+
+      - name: Install
+        run: |
+          python -m pip install ".[cli]"
+
+      - name: Run Lint
+        run: |
+          pylint --rcfile tests/pylint.rc peakrdl_regblock
+
+#-------------------------------------------------------------------------------
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -r tests/requirements.txt
+
+      - name: Install
+        run: |
+          python -m pip install ".[cli]"
+
+      - name: Type Check
+        run: |
+          mypy --config-file tests/mypy.ini src/peakrdl_regblock
+
+#-------------------------------------------------------------------------------
+  build:
+    needs:
+      - test
+      - lint
+      - mypy
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        name: Install Python
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install build
+
+      - name: Build sdist
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: |
+            dist/*.tar.gz
+            dist/*.whl
+
+#-------------------------------------------------------------------------------
+  deploy:
+    needs:
+      - build
+
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+
+    # Only publish when a GitHub Release is created.
+    if: github.event_name == 'release'
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@release/v1