Skip to content

Add source_lists and --create --manifest-dir, release 0.5.0 - #34

Merged
olagrottvik merged 4 commits into
mainfrom
claude/hog-testing-environment-planning-9jzb1n
Oct 14, 2026
Merged

olagrottvik merged 4 commits into
mainfrom
claude/hog-testing-environment-planning-9jzb1n

Conversation

@olagrottvik

@olagrottvik olagrottvik commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Third-party HDL libraries, typically git submodules, have no ohsh manifests and their files should not be changed. This adds two ways to give them manifests from your own repository, a CI job that runs ohsh against a realistic hog project using them, and bumps the version to 0.5.0.

Changes

  • source_lists manifest key: reads a module's sources from text files that list them in compile order, relative to the list file (blank lines and # comments skipped). Fits libraries that ship their own order, such as Open Logic's compile_order.txt. Source-list files come before sources. --fix only sorts sources.
  • --create --manifest-dir DIR: writes the generated manifests under DIR, mirroring the source layout under --top-dir, with ../ paths into the library. Manifests already in DIR count as existing, so reruns only add new ones.
  • Source paths that leave the manifest directory with ../ are written normalized, without the .. parts.
  • demo job in integration.yml: checks out logvik-org/ohsh-demo and runs its checks with this PR's ohsh: ohsh --check on 29 manifests, GHDL and NVC simulation in libraries.src order, and hog's own ./Hog/Do SIMULATION (GHDL, no Vivado). The demo is a hog repository with hog, Open Logic (via source_lists) and colibri (via --create --manifest-dir) as submodules.
  • Docs: manifest format and manifest actions pages, README options table, and the example READMEs.
  • Version 0.5.0: __version__ and a [0.5.0] - 2026-10-14 section in the CHANGELOG.

Testing

  • make test: 109 passed, with new tests for both features, path normalization and the new validation.
  • make lint and make docs pass.
  • scripts/run-examples.sh ghdl/simple ghdl/advanced hog/simple hog/advanced passes locally.
  • ohsh-demo CI is green on its latest commit.

Notes

  • After merge, ohsh-demo's CI should install ohsh from main or the 0.5.0 release instead of this branch.
  • Publishing the release (tag v0.5.0) is left for after the merge, as described in CONTRIBUTING.md.

@read-the-docs-community

read-the-docs-community Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 ohsh | 🛠️ Build #35140419 | 📁 Comparing 576b9b6 against latest (80fce1d)

  🔍 Preview build  

2 files changed
± manifest-actions.html
± manifest-format.html

@olagrottvik
olagrottvik force-pushed the claude/hog-testing-environment-planning-9jzb1n branch from 50b3b8c to 576b9b6 Compare October 14, 2026 11:11
@olagrottvik olagrottvik changed the title Add source_lists and --create --manifest-dir for third-party libraries Add source_lists and --create --manifest-dir, release 0.5.0 Oct 14, 2026
@olagrottvik
olagrottvik merged commit c08f463 into main Oct 14, 2026
16 checks passed
@olagrottvik
olagrottvik deleted the claude/hog-testing-environment-planning-9jzb1n branch October 14, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant