search

matrx-software / matrx

Human-Agent Teaming Rapid Experimentation Software
https://www.matrx-software.com
MIT License
10 stars 3 forks source link

Automate building and upload to PyPi #104

Open jwaa opened 4 years ago

jwaa commented 4 years ago

Is your feature request related to a problem? Please describe. Currently, after a release we need to manually upload the package to PyPi. This can quickly become tedious and add overhead, as well as cases where this is forgotten. This is may especially hold for patch releases.

Describe the solution you would like We can automate the upload to PyPi using GitHub Actions. See this guide: https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/

Also, there is a repo that sort of provides this already: https://github.com/pypa/gh-action-pypi-publish

The downside is that this only automates the uploading process... not the actual build. We still need to run this ourselves.

Describe alternatives you have considered The alternative is to write a python script ourselves we can run to build and upload a new package. However, this is then disconnected from a release tag, commit and release on GitHub.

We can discuss what fits best in our workflow. Adding the upload step to such a script may add transparency as it is clearly state in a single spot what is build and uploaded. However, if you only wish to build and not the upload we require two seperate scripts. Also, uploading to TestPyPi would require similar scripts where only the link reference is different.

I guess this needs some further discussion on what we want.

Additional context N/A

jwaa commented 3 years ago

@thaije Is this something we want to setup with v2.1?

thaije commented 3 years ago

Well, as it saves us about 5 seconds every month, according to xkcd we can spend 5 minutes on automating it. But on a more serious note, similar to issue #126 I would postpone this issue in favor of more critical bugs and issues.