First PR into main

[joe-p]

Once this is merged into main a beta release should be triggered. Once everything is confirmed working, we can merge from main into release/1.x to trigger the first stable release.

[joe-p]

@PhearZero can you review this to verify the CD setup looks good.

PRs into main trigger beta release

PRs into release/* (from main) trigger stable release.

[PhearZero]

@joe-p ran a few dry runs and merges locally and it seems good to go configuration wise 🎉. (it may need to disallow version zero to match the correct semantics )

The only two things I can see in the actions:

1. Right now the cd action is set to be manually triggered and I couldn't find a dispatcher. May want to add a dedicated action that dispatches the cd action with opinions like dry_run:false on push to main and release/*.

2. Not sure if this is valid but the gh-action-pypi-publish has the package url in the documentation as a ENV variable. Do you know if that is optional @aorumbayev ?

[joe-p]

Right now the cd action is set to be manually triggered and I couldn't find a dispatcher. May want to add a dedicated action that dispatches the cd action with opinions like dry_run:false on push to main and release/*.

Ah good catch. How much do we value manual dispatches? We can setup a reusable workflow that can be dispatched and on push, but probably simpler to just change this workflow to on push only, otherwise we need to redefine inputs on workflow_dispatch and workflow_call because they can't be shared

[PhearZero]

but probably simpler to just change this workflow to on push only

+1 for changing it to push to the distribution channels in the single action and KISS.

We may find a good reason to abstract it into it's own workflow/action at a later date, (I know it's been useful for MakerX)

[joe-p]

Ok I've updated the CD workflow to essentially do everything except docs on both branches. Docs will only get published on stable releases. We'll probably want to think about how/if we do docs for historical versions, but not a priority for now.

Edit: Also set tool.semantic_release.allow_zero_version = false so this first release should be 1.0.0-beta

[PhearZero]

We'll probably want to think about how/if we do docs for historical versions, but not a priority for now.

We should sync with @aorumbayev and @SilentRhetoric, I've talked a bit with both of them on documentation generation. The docstring examples with test runners like doctests could be a really powerful practice. It would be good to align in general and see what we can come up with!

Edit: LGTM

[aorumbayev]

@PhearZero thats the example of a doctest using https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html. In case remaining docs need to use them, should be a matter of replacing python with testcode to make them runnable

[PhearZero]

Let's sync on this! It also works in docstrings, here is an example that also comes in the intelisense 🔥: