GitHub CI with Prebuilt Binary Wheel

[khwong-c]

Feature

Closing #187

• Building Linux X86-64 Binary Wheel
• Publish to PyPi if a tag is pushed in the format of v*

Result Preview

You may preview the CI execution Result here.
https://github.com/khwong-c/hdlConvertor/actions/runs/7487908840

The Artifact PythonPackage contains all prebuilt binary wheel.
Open one of them and you can find the ANTLR4 Binary in the hdlConvertor.libs directory.
They will be installed and loaded by pip install hdlConvertor if it is available.

Detail explained

We are not changing the build script, instead bundling the shared object (*.so) required by hdlConvertor
This can be done easily with auditwheel package.
External binary dependencies are injected into the wheel after repair.

Different platforms need different tools for repairing the wheel.
I have done the Linux one and you might follow the same pattern and complete the others

platform	package
Linux	auditwheel
Mac	delocate
Windows	delvewheel

What if ...

1. I want to move on Meson build?

• This script does not care if you are using CMake / Meson, as long as you are using setup.py as your entry point for the build.

2. I want to perform debug build and testing?

• Please fill in the details in the build_and_test job.

3. I want to build with other Python interpreters? (e.g. Pypy)

• Please add the Python version in the matrix.python-version accordingly.
  Reference: https://github.com/actions/setup-python?tab=readme-ov-file#basic-usage

4. I want to test this on other branches (e.g. mensonbuild )

• This PR only adds a single file, without any changes to other files. It should be an easy git merge master once the PR is merged to master.

[Nic30]

Nice, it seem to work, i do not test release for now, can you please prepare CI config also for windows?

[khwong-c]

I don't have a working build on Windows.
Would you mind providing the instructions for a functional build on Windows?
Similar case for Mac.

[khwong-c]

@Nic30 BTW. The Ubuntu version is intended to be 20.04.
It's for backward compactibility for the end-developer. (not everyone is running on 23.10)
It will break the auditwheel command

Furthermore, the latest ubuntu on GitHub is 22.
Your workflow will never be served.

[Nic30]

OK, reverting in 4bcce70

[Nic30]

There is https://github.com/Nic30/hdlConvertor/blob/master/.appveyor.yml
https://ci.appveyor.com/project/nic30/hdlconvertor/builds/48947326
The appveyor has often problems with not enough RAM.
In addition some MSVC versions causing enormous memory leaks.