Merge starbase/main #145
Merged
Merge starbase/main #145
Conversation
This file contains 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
…on-test # Conflicts: # tox.ini
Most static checks don't need the code to be installed at all, but type checking can require the code and its dependencies.
tools: Make typing use an editable install
tests: Ensure coverage gets per-environment filenames
Done the same way as in rockcraft Co-authored-by: Tiago Nobrega <tiago.nobrega@canonical.com>
docs: Basic sphinx docs
Rather than statically declaring the project to be "starcraft" all over the place, prefer excluding directories.
chore(tools): Make pyproject.toml exclude rather than statically include
chore(deps): update dependency tox to v4.4.2
chore(deps): update release-drafter/release-drafter action to v5.22.0
chore(deps): update dependency tox-ignore-env-name-mismatch to v0.2.0.post2
chore(deps): update dependency pytest to v7.2.1
Ensure that ruff only gets updated by renovate or explicitly in PRs. This will prevent random CI breakages until ruff is stable.
New ignore: Too many arguments on test functions * chore(lint): Ruff autofixes for new pylint
Enabling the too means solving a bunch of linting issues _plus_ type issues that are uncovered as ruff annotates things like constructors. This technical debt is tracked in issue #146.
Like ruff, pyright uncovers a whole set of typing errors which should be addressed in a separate changeset. This technical debt is recorded in issue #147
The existing docs don't hard-wrap lines, so disable the check for line-too-long. Fix some other issues. With this, all lint- environments in tox should be working.
Reduce from 80% to 76%, which is the value currently achieved in the codebase.
This commit brings craft-cli's documentation into the format and build process that Starbase imposes. The specific Makefile and requirements files in docs/ are removed in favor of the tox 'build-docs' and 'autobuild-docs' that use the dependencies from pyproject.toml. sphinx-build is called *without* treating warnings as errors, because the auto-generated doc process generates a bunch of warnings about circular imports and duplicate declarations that should be fixed at a later date. Also remove .readthedocs.yml in favor of the starbase-provided .readthedocs.yaml.
Codecov Report
@@ Coverage Diff @@
## main #145 +/- ##
=======================================
Coverage ? 70.49%
=======================================
Files ? 6
Lines ? 983
Branches ? 187
=======================================
Hits ? 693
Misses ? 287
Partials ? 3 |
- Remove README.rst and HACKING.rst, as they reference Starcraft - Keep only the correct release-drafter yaml file
lengau
reviewed
Jun 7, 2023
|
I added Claudio's |
|
I removed branch protection rules to allow this to land when ready |
|
I have also disabled automerge to avoid any accidents |
Since ruff is currently disabled (pending issue #146), temporarily add pylint so that we have at least some form of "stylistic" linting of the code. Once we add ruff we can undo this commit, remove .pylintrc and remove the many "# pylint:" comments on the code itself.
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.
This PR integrates craft-cli with the current "state of the art" implemented by Starbase. It's a huge changeset because it's a merge of two distinct repositories, but the idea is that future merges will be easier/less painful.
The general strategy was this: First I merged
starbase/maininto this branch, and for the conflicts I preferred starbase's version for most cases, unless the fix was very straightforward. This merge is commit 13c852f.After that, I added commits to migrate craft-cli's way of doing things to starbase's. For example, the first commit after the merge removes
setup.pyandsetup.cfgand adds the config topyproject.toml. This migration was done manually and I inspected/tested the resulting wheel, etc. The next commits add fixes for the individual linters, coverage, and a bigger one for the docs. Then I removed the files that are no longer needed (like the Makefiles).Hopefully, the task of reviewing per-commit starting at that merge (or the one right after it, since it's hard to review the merge) won't be too onerous because each commit is reasonably self-contained; if it is, tell me and I can see about opening multiple PRs.