Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Paebbels/pipeline #1

Merged
merged 5 commits into from
Mar 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/issue_template/Feature Request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Problem and/or Feature Description
<!--
Is your feature request related to a problem?
Please describe.
-->

> [!NOTE]
> Add a clear and concise description of what the problem is.


# Suggested Solution
<!--
Describe the solution you'd like.
-->

> [!NOTE]
> Add a clear and concise description of what you want to happen.

# Alternatives
<!--
Describe alternatives you've considered.
-->

> [!TIP]
> Add a clear and concise description of any alternative solutions
> or features you've considered.

# Additional context

> [!TIP]
> Add any other context or screenshots about the feature request here.
62 changes: 62 additions & 0 deletions .github/issue_template/Problem Report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<!--
We do not consider any issue immediately a bug.
In any case, an issue is a deviation from an expected
behavior. Therefore, we write a problem description.
Then the problem is investigated and either it's a bug
or a misunderstanding/misinterpretation.
-->

# Problem
<!--
What diverging behavior was observed? Please describe
the behavior and how to reproduce.
-->

> [!NOTE]
> Write problem description here.


# Root Cause
<!--
What is the root cause? This may need further investigation
before agreeing on a final solution.
-->

> [!TIP]
> Write root cause description here.
>
> Might be filled in after investigation.


# Solution
<!--
Solution to (finally) solve the problem in a new revision.
-->

> [!TIP]
> Write solution description here.
>
> If possible propose a solution.
> Might be filled in after investigation and root cause detection.


# Workaround
<!--
Intermediate solution (workaround), if even possible.
-->

> [!TIP]
> Write workaround description here.
>
> If possible propose a workaround.
> Might be filled in after investigation.


## Actions
<!--
Proposed next steps to either narrow down the problem, develop
a workaround or to sketch a workaround.
-->

1. {-fill out-}
1. {-fill out-}
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# New Features

* tbd
* tbd

# Changes

* tbd
* tbd

# Bug Fixes

* tbd
* tbd

# Documentation

* tbd
* tbd

# Tests

* tbd
* tbd

----------
# Related Issues and Pull-Requests

* tbd
* tbd
47 changes: 47 additions & 0 deletions .github/workflows/Pipeline.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Verify PoC and Generate Documentation

on:
push:
pull_request:

jobs:
Documentation:
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r4
with:
requirements: '-r docs/requirements.txt'
doc_directory: 'docs'
html_artifact: 'PoC-HTML'
latex_artifact: 'PoC-LaTeX'

PublishToGitHubPages:
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
needs:
- Documentation
with:
doc: 'PoC-HTML'
# coverage: 'PoC-Coverage-HTML'

Release:
uses: pyTooling/Actions/.github/workflows/NightlyRelease.yml@r4
if: startsWith(github.ref, 'refs/tags/v')
needs:
# - Ubuntu
# - Windows
# - PublishCoverageResults
# - PublishTestResults
- PublishToGitHubPages
secrets: inherit
permissions:
contents: write
actions: write
attestations: write
with:
prerelease: true
replacements: |
poc=1.3.0
nightly_name: "v1.3.0"
nightly_description: |
# The PoC-Library %poc%
inventory-json: "inventory.json"
inventory-version: "1.3.0"
assets: |
54 changes: 0 additions & 54 deletions docs/References/CmdRefs/Compile-UVVM-ps1.rst

This file was deleted.

54 changes: 0 additions & 54 deletions docs/References/CmdRefs/Compile-UVVM-sh.rst

This file was deleted.

70 changes: 0 additions & 70 deletions docs/References/CmdRefs/Compile-Xilinx-ISE-ps1.rst

This file was deleted.

Loading
Loading