Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
This repo had no CI, used the legacy
setup.pypackaging format, and had no documentation site. I've set up the CI onmolgenis-flwr-armadillorepo and thought maybe we could use the same?What's changed
setup.pytopyproject.toml— hatchling build backend, bumpedpython_requiresto>=3.10,added dev extras (pytest, pytest-cov, ruff)
ci.yml) — lint with ruff + pytest with coverage across Python 3.10/3.11/3.12, Codecovupload on 3.12
release.yml) — builds package and creates GitHub release onv*tagsdocs.yml) — mkdocs-material build on PRs, deploy to GitHub Pages on push to mainmkdocs.yml,docs/index.md,docs/reference.mdwith API reference via mkdocstringstests/test_import.py)Repo settings to configure
On the other repo, I added the following branch protection rules on
main:mainI also set the repo website as the one generated with mkdocs.
How to test