Tests

feat: add verilator as a linter tool #47

	name: Tests

	on:
	push:
	branches:
	- main
	pull_request:
	types: [opened, synchronize]

	jobs:
	test-verilator:
	runs-on: ubuntu-latest

	env:
	VERILATOR_VERSION: v5.024
	VERILATOR_INSTALL: /opt/verilator

	steps:
	- name: Cache Verilator
	id: cache-verilator
	uses: actions/cache@v4
	with:
	path: ${{ env.VERILATOR_INSTALL }}
	key: verilator-${{ env.VERILATOR_VERSION }}-${{ runner.os }}
	save-always: true

	- name: Build Verilator
	if: steps.cache-verilator.outputs.cache-hit != 'true'
	run: \|
	# Install dependecies
	sudo apt-get update
	sudo apt-get install -y git help2man perl python3 make autoconf g++ flex bison ccache libfl2 libfl-dev

	# Clone Verilator and checkout version
	git clone https://github.com/verilator/verilator.git
	cd verilator
	git checkout ${{ env.VERILATOR_VERSION }}

	# Build Verilator
	autoconf
	./configure --prefix ${{ env.VERILATOR_INSTALL }}
	make -j$(nproc)
	sudo make install

	- name: Checkout source code
	uses: actions/checkout@v4
	with:
	submodules: "recursive"

	- name: Prepare evinronment
	run: \|
	sudo apt-get install -y g++ flex bison ccache
	echo "${{ env.VERILATOR_INSTALL }}/bin" >> $GITHUB_PATH
	echo "${{ github.workspace }}/contrib/svunit/bin" >> $GITHUB_PATH

	- name: Lint the package
	run: make lint_verilator

	- name: Test the package
	run: make -C tests test_verilator

	- name: Test documentation examples
	run: make -C docs/modules/ROOT/examples/selftest test_verilator

	- name: Parse test results
	uses: mikepenz/action-junit-report@v4
	if: always()
	with:
	report_paths: '**/work_verilator/tests.xml'
	require_tests: true

Provide feedback