Repository navigation
Conversation
yggdrasil/flow/utils was the only directory with Python modules and no __init__.py, and namespaces = true was set to pick it up. It now has a docstring-only initializer, and packages.find runs with namespaces = false
Six docstrings cited entries of docs/TECH_DEBT_LEDGER.md, a local file the repository does not track. Each now states the limitation itself. The watchers package docstring describes AbstractWatcher, PlanWatcher and SeqDataWatcher instead of calling them deprecated after a certain plan phase.
…date conventions for known gaps and test style
…checkout to v7 actions - Node 24 majors
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.
This PR focuses on post-merge corrections and clarifications for the package consolidation work, along with several workflow and documentation improvements. The most significant changes address Python package discovery and structure, clarify documentation around known limitations and references to tech debt, and update CI workflows to use the latest GH Actions.
Python packaging and structure:
pyproject.tomlto disable namespace packages by settingnamespaces = false, ensuring only directories with an__init__.pyare included as packages.__init__.pytoyggdrasil/flow/utils/to ensure it is recognized as a package.tests/test_package_layout.py) to verify that every source directory containing Python modules has an__init__.py, preventing accidental omission from distributions.Documentation and tech debt clarifications:
CLAUDE.md,README.md, andoverview.md) to remove references to the number of tests and to clarify that known gaps should be described directly, not just cited via a tech-debt ledger, since the ledger is untracked. [1] [2] [3] [4]Docstring and code comments updates:
OpsWriter,PlanBuilder,YggdrasilCore, etc.) to explain limitations directly instead of referencing the untracked tech-debt ledger. [1] [2] [3]CI/CD workflow updates:
docs.yml,lint.yml,security.yml,tests.yml) to use the latest major versions ofactions/checkout,actions/setup-python, and related actions for improved security and support. [1] [2] [3] [4] [5] [6] [7] [8]These changes ensure the package structure is robust and discoverable, CI is up-to-date, and documentation accurately reflects current practices and known limitations.
References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23] [24]