Skip to content

README.md

Latest commit

 

History

History
155 lines (114 loc) · 7.63 KB

README.md

File metadata and controls

155 lines (114 loc) · 7.63 KB
Raw

MontFerret Contrib

contrib is a workspace for independently versioned Ferret modules. This README acts as the top-level index for the modules currently available in this repository.

Available Modules

Module Description README
ai/llm Text generation, chat, extraction, and classification under AI::LLM for Ferret. modules/ai/llm/README.md
archive Sandboxed ZIP, TAR, TAR.GZ, and TGZ inspection and extraction under ARCHIVE. modules/archive/README.md
csv CSV module and CSV namespace helpers for Ferret. modules/csv/README.md
db/postgres Postgres database handles under DB::POSTGRES for Ferret. modules/db/postgres/README.md
db/redis Redis connection handles and generic commands under DB::REDIS for Ferret. modules/db/redis/README.md
db/sqlite SQLite database handles under DB::SQLITE for Ferret. modules/db/sqlite/README.md
document/pdf Read-only PDF document handles under DOCUMENT::PDF for Ferret. modules/document/pdf/README.md
document/xlsx Excel-compatible .xlsx workbook handles under DOCUMENT::XLSX for Ferret. modules/document/xlsx/README.md
net/rest REST-style HTTP API clients under NET::REST for Ferret. modules/net/rest/README.md
security/jwt JWT token signing, verification, and inspection helpers under SECURITY::JWT for Ferret. modules/security/jwt/README.md
security/oauth2 OAuth 2.0 client grants and token helpers under SECURITY::OAUTH2 for Ferret. modules/security/oauth2/README.md
toml TOML module and TOML namespace helpers for Ferret. modules/toml/README.md
web/article Article extraction helpers under WEB::ARTICLE for Ferret. modules/web/article/README.md
web/html HTML module for Ferret. modules/web/html/README.md
web/robots robots.txt parsing and policy helpers under WEB::ROBOTS for Ferret. modules/web/robots/README.md
web/sitemap Sitemap discovery helpers under WEB::SITEMAP for Ferret. modules/web/sitemap/README.md
xml XML module and XML namespace helpers for Ferret. modules/xml/README.md
yaml YAML module and YAML namespace helpers for Ferret. modules/yaml/README.md

Module-specific documentation lives in each module README and will be expanded there later.

Module Manifests

Each module directory contains a ferret.yaml document conforming to Ferret Module Manifest v1. Install the pinned manifest validator, then validate the complete manifest inventory and its repository conventions with:

make install-manifest-validator
make validate-manifests

The module release commands update manifest versions as part of the atomic release transaction described below.

Development

Use the repo-level Makefile to run module commands:

make test [module ...]
make lint [module ...]
make fmt [module ...]

If no module names are provided, the commands run against all available modules.

Support packages under pkg/ can be updated across module go.mod and go.sum files with:

make update-package <package> <version> [module ...]

If no module names are provided, only modules that already require the package are updated.

The Ferret runtime dependency can be updated across all workspace go.mod files that require it with:

make update-ferret <version>

Release Procedure

Each module is released by creating and pushing a module-specific git tag in the format:

modules/<module>/v<version>

  1. Validate the target module:
make test <module>
make lint <module>
  1. From a clean main branch synchronized with origin/main, run a release target:
# Auto-bump from latest module tag
make release-patch <module>
make release-minor <module>
make release-major <module>

# Explicit semantic version (including pre-release)
make release-pre xml 1.0.0-rc.1

# Auto-bump latest matching pre-release
make release-pre xml rc

# Auto-bump latest matching pre-release for all modules.
# Interactive runs prompt once for a base version when modules have no initial tag.
make release-pre-all rc

# Non-interactive bulk prereleases can set the initial base version explicitly.
RELEASE_PRE_BASE_VERSION=1.0.0 make release-pre-all rc

A single-module release updates and validates its ferret.yaml, creates one release commit when the version changed, creates the annotated module tag at that commit, and atomically pushes main and the tag. release-pre-all updates all module manifests in one release commit and atomically pushes that commit with every module tag, so a failed push cannot leave a partial bulk release. Set RELEASE_CHECK_ONLY=1 to validate a planned release without creating a commit, tag, or remote change.

Every pushed modules/**/v* tag triggers the Barn publication workflow. The workflow uses Barn's public Go API to validate the tagged module, prepares the immutable registry source records, and opens one ready-for-review pull request in MontFerret/barn. The release appears in the public registry only after that pull request passes Barn CI, is reviewed, and is merged. Re-running the workflow updates the existing publication branch or succeeds without changes when the version is already published.

Support-package tags under pkg/ do not trigger Barn publication.

Support packages under pkg/ are released by creating and pushing a package-specific git tag in the format:

pkg/<package>/v<version>

  1. Validate the target package:
make test-packages <package>
make lint-packages <package>
  1. Create and push an annotated tag using the package release targets:
# Auto-bump from latest package tag
make release-package-patch <package>
make release-package-minor <package>
make release-package-major <package>

# Explicit semantic version (including pre-release)
make release-package-pre common 0.1.0-rc.1

# Auto-bump latest matching pre-release
make release-package-pre common rc
  1. Update module requirements and sums that use the released package:
make update-package <package> 0.1.0