CI Add GitHub workflow for creating releases

[BenjaminBossan]

Solves #34

Minor additions:

• Added some documentation around releases and developing skops.
• Fix a typo (sklearn -> skops)
• Make test dependencies installable

Note: For obvious reasons, I haven't tested yet whether the GH action really works.

[BenjaminBossan]

I'm getting this error:

requests.exceptions.HTTPError: 400 Client Error: Bad Request for url: https://huggingface.co/api/models/skops/test-4a551f91-bec7-4996-9e9f-ed75ecb0395c/commit/main (Request ID: xg-VOMqxP3BFWz4qxgtbk)

(link)

Any idea what this could be about? It seems to be unrelated to my changes.

[adrinjalali]

Nice!

[adrinjalali]

Thos 400 errors are because the backend is unstable and sometimes gives 400. We just re-run the tests for them to pass, and they almost always do with max 3 retries. We can also use a retry decorator for our tests.

[adrinjalali]

The error on the CI doesn't seem like the usual we get. Would you what's causing it @SBrandeis?

                except Exception as exc:
                    # Raise the first exception encountered
>                   raise RuntimeError(
                        f"Error while uploading {operation.path_in_repo} to the Hub"
                    ) from exc
E                   RuntimeError: Error while uploading model.pkl to the Hub
/opt/hostedtoolcache/Python/3.8.13/x64/lib/python3.8/site-packages/huggingface_hub/_commit_api.py:263: RuntimeError

[adrinjalali]

I just noticed this action only publishes the built packages. We need to build them before uploading them.

[BenjaminBossan]

I should have checked, my bad. I added a build step above.

[adrinjalali]

Let's see how it goes.

[adrinjalali]

oh, didn't know this does the thing.

[BenjaminBossan]

Same, it was new to me. But I figured if the docs recommend this way, it is best practice.