Enable build pipeline via GitHub Actions to automate quality checks and artifact assembly:
[x] add branch protection rule for main requiring PR to merge
[x] run pre-commit hooks
[x] run pytest tests
[x] run mypy type checks
[x] fail build if any of above steps fail
[x] build (but do not publish) documentation
[x] build (but do not publish) PyPI package
Require a PR to merge to main (disable direct push), and require a green build pipeline before merge is allowed.
Subsequent issues will cover the release process wherein a new version is created and the code and documentation artifacts are published (to PyPI, GH Pages and readthedocs). Additional checks to consider in the future include test and documentation coverage reports.
Right now the SAMMO docs site hosted on GH Pages is built from a separate gh-pages branch. This issue moves towards building docs and code from the same branch (so, moving from "publishing from a branch" style to "publishing with a custom GitHub Actions workflow")
Enable build pipeline via GitHub Actions to automate quality checks and artifact assembly:
mainrequiring PR to mergepre-commithooksRequire a PR to merge to main (disable direct push), and require a green build pipeline before merge is allowed.
Subsequent issues will cover the release process wherein a new version is created and the code and documentation artifacts are published (to PyPI, GH Pages and readthedocs). Additional checks to consider in the future include test and documentation coverage reports.
Right now the SAMMO docs site hosted on GH Pages is built from a separate
gh-pagesbranch. This issue moves towards building docs and code from the same branch (so, moving from "publishing from a branch" style to "publishing with a custom GitHub Actions workflow")