Cleaned up workflow files, Adds PEP 561 compliance

[eddiebergman]

This PR cleans up the github action workflow files to accomplish few things:

• Add's PEP 561 compliance (exports types so other packages can be aware of them)
• Allow manual workflow_dispatch on actions that might require it (can manually trigger them from github UI)
• Prevent the double trigger of actions by making push and pull_request and more strict.
  • A push to a pull request should no longer cause double the amount of tests to run (along with the other workflows that had on: [push, pull_request]
• Some general cleanup, giving names to some actions, adding some linebreaks to break up things, ...
• Disabling the example.yaml workflow as it did nothing but install SMAC. (Also removed the parameterization of it)
• pytest.yaml:
  • Now scheduled to auto run everyday instead of every week
  • Clean up the body of the steps and move some things to env var
  • Scaffold for matrix that includes windows and mac testing (currently excluded, see comments)
  • Includes tests for Python 3.10
  • Changed the boolean flags in the matrix to just be a categorical, easier to read

Once I figure out how to make the tests work windows and macos, I will create a new PR and enable windows/mac testing.

[codecov]

Codecov Report

Merging #802 (06bfb88) into development (814b034) will increase coverage by 0.03%.
The diff coverage is 89.47%.

@@               Coverage Diff               @@
##           development     #802      +/-   ##
===============================================
+ Coverage        87.10%   87.13%   +0.03%     
===============================================
  Files               68       68              
  Lines             6227     6236       +9     
===============================================
+ Hits              5424     5434      +10     
+ Misses             803      802       -1     

Impacted Files	Coverage Δ
smac/tae/execute_ta_run_old.py	93.33% <89.47%> (-0.79%)	⬇️
smac/optimizer/smbo.py	91.02% <0.00%> (+0.70%)	⬆️
smac/epm/rfr_imputator.py	95.77% <0.00%> (+1.48%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 814b034...06bfb88. Read the comment docs.

[benjamc]

Looks good!
Should we remove .github/workflows/examples.yml?
@renesass @dengdifan @mfeurer @eddiebergman

[eddiebergman]

I would remove that file as it doesn't really do anything but I wasn't sure, so I just deactivated it for now

[mfeurer]

That file was there to run the commandline examples. It would be better to reactivate this behavior to ensure that these examples are working as expected.

[eddiebergman]

That's not what it's doing but isn't that covered with sphinx-gallery in the docs workflow?

[eddiebergman]

I also fixed the PEP 561 compliance check and then also added the compliance.

This means a user using SMAC with import smac will have access to the type information of smac's API in their editor when they use it.

[mfeurer]

That's not what it's doing but isn't that covered with sphinx-gallery in the docs workflow?

No, sphinx-gallery should only cover the python examples. The command line examples are not covered by that, but should be tested as well. And it used to do this, not sure when this was disabled.

[renesass]

That's on me. When we integrated the new docs, we couldn't get the tests working and decided to exclude it for now. But yeah, we will integrate them again in 1.1.2.