search

goatchurchprime / jupyter_micropython_kernel

Jupyter kernel to interact with a MicroPython/ESP8266 over the serial REPL
BSD 3-Clause "New" or "Revised" License
149 stars 33 forks source link

add packaging details for jupyter_micropython_kernel module #48

Closed MatthewCroughan closed 3 years ago

MatthewCroughan commented 4 years ago

The minor version has been incremented twice since I screwed up twice. PyPi does not allow you to re-use or write over the top of previous versions, sensibly, so I had to increment it. The README.md for this repo will have be modified to better suit what PyPi expects, it would be neater for us too.

Manually Publishing

  1. Install flit python3 -m pip install flit
  2. Make changes to this repo's master
  3. Increment __version__ in jupyter_micropython_kernel/__init__.py
  4. Make sure all of your changes are committed, and ideally pushed
  5. Run flit publish

Thoughts on automated publishing

Ideally, it would be best if there was a way to automate these steps using github actions.

Once automated, the workflow would be:

  1. git checkout -b feature-name
  2. Work on feature
  3. git commit -m "added bla" -m "type: minor" (major | minor)
  4. Make a PR to get it merged to master
  5. Once merged, the steps noted in Manually Publishing will be complete for you, and the version will be incremented based on your second commit message key value type:
graingert commented 4 years ago

you should also delete the setup.py file