CI polish to target 0.0.7 release

FlyRanch / figurefirst

A layout-first approach to figure making

http://flyranch.github.io/figurefirst

MIT License

80 stars 15 forks source link

CI polish to target 0.0.7 release #58

Open psilentp opened 4 years ago

psilentp commented 4 years ago

Cleans up some of the CI by moving all the tests to tox, also enables pypi deployment by pushing a tag (haven't tested this yet) and moves control of all versioning to vcs.

consolidated github action and .tox workflow steps closes #56
add another workflow to run black and flake8. At the moment these are set to always return a pass but we can read the error reports in the action output console like this one Perhaps we can set these as mandatory later.
Added some badges to report on the test results and pypi version.
moves versioning to setuptools_scm
workflow code to push to test-pypi on all pushes pypi on tag push.

clbarnes commented 4 years ago

Is a separate workflow for doc publishing strictly necessary? Readthedocs automatically generates and hosts pages generated with sphinx.

psilentp commented 4 years ago

Is a separate workflow for doc publishing strictly necessary? Readthedocs automatically generates and hosts pages generated with sphinx.

Probably not - though we've already got some published to github pages. Mostly I was hoping to fix some errors in the documentation (like the one in #57) and push them out with a tagged 0.0.7 release - so at least we have a starting point.

I haven't used readthedocs - I'm game for whatever is easiest.

clbarnes commented 4 years ago

Ah, having refreshed my memory, there are 2 separate documentation pages - gh-pages as a landing page/ quickstart tutorial, readthedocs for sphinx-generated API docs. That seems like a reasonable distinction to have - whatever simplicity would be gained from having a single host may be wiped out by the hoops you'd have to jump through for sphinx to deal with the landing page.

psilentp commented 4 years ago

Ah, having refreshed my memory, there are 2 separate documentation pages - gh-pages as a landing page/ quickstart tutorial, readthedocs for sphinx-generated API docs. That seems like a reasonable distinction to have - whatever simplicity would be gained from having a single host may be wiped out by the hoops you'd have to jump through for sphinx to deal with the landing page.

Just read up on readthedocs and it looks like it handles tags nicely, so as long as we are reasonably committed to semver there shouldn't be a problem.