Skip to content

CUSTOMIZATION.md

Latest commit

 

History

History
164 lines (107 loc) · 5.12 KB

CUSTOMIZATION.md

File metadata and controls

164 lines (107 loc) · 5.12 KB

Customization Guide

This guide covers advanced customization options for Rhiza-based projects.

🛠️ Makefile Hooks & Extensions

Rhiza uses a modular Makefile system with extension points (hooks) that let you customize workflows without modifying core files.

Important: All customizations should be made in your root Makefile, not in .rhiza/. The .rhiza/ directory is template-managed and will be overwritten during sync operations.

Available Hooks

You can hook into standard workflows using double-colon syntax (::) in your root Makefile:

  • pre-install / post-install - Runs around make install
  • pre-sync / post-sync - Runs around repository synchronization
  • pre-validate / post-validate - Runs around validation checks
  • pre-release / post-release - Runs around release process
  • pre-bump / post-bump - Runs around version bumping

Example: Installing System Dependencies

Add to your root Makefile (before the include .rhiza/rhiza.mk line):

pre-install::
	@if ! command -v dot >/dev/null 2>&1; then \
		echo "Installing graphviz..."; \
		sudo apt-get update && sudo apt-get install -y graphviz; \
	fi

This hook runs automatically before make install, ensuring graphviz is available.

Example: Post-Release Tasks

Add to your root Makefile:

post-release::
	@echo "Running post-release tasks..."
	@./scripts/notify-team.sh
	@./scripts/update-changelog.sh

This runs automatically after make release completes.

Example: Custom Build Steps

Add to your root Makefile:

post-install::
	@echo "Installing specialized dependencies..."
	@uv pip install some-private-lib
	
##@ Custom Tasks
train-model: ## Train the ML model
	@uv run python scripts/train.py

🔒 CodeQL Configuration

The CodeQL workflow (.github/workflows/rhiza_codeql.yml) performs security analysis on your code. However, CodeQL requires GitHub Advanced Security, which is:

  • ✅ Available for free on public repositories
  • ⚠️ Requires GitHub Enterprise license for private repositories

Automatic Behavior

By default, the CodeQL workflow:

  • Runs automatically on public repositories
  • Skips automatically on private repositories (unless you have Advanced Security)

Controlling CodeQL

You can override the default behavior using a repository variable:

  1. Go to your repository → Settings → Secrets and variables → Actions → Variables tab
  2. Create a new repository variable named CODEQL_ENABLED
  3. Set the value:
    • true - Force CodeQL to run (use if you have Advanced Security on a private repo)
    • false - Disable CodeQL entirely (e.g., if it's causing issues)

For Private Repositories with Advanced Security

If you have a GitHub Enterprise license with Advanced Security enabled:

# Enable CodeQL for your private repository
gh variable set CODEQL_ENABLED --body "true"

For Users Without Advanced Security

No action needed! The workflow will automatically skip for private repositories. If you want to completely disable it:

# Disable CodeQL workflow
gh variable set CODEQL_ENABLED --body "false"

Or delete the workflow file:

# Remove CodeQL workflow
git rm .github/workflows/rhiza_codeql.yml
git commit -m "Remove CodeQL workflow"

⚙️ Configuration Variables

You can configure certain aspects of the Makefile by overriding variables. These can be set in your main Makefile (before the include line), a local.mk file (for local developer overrides), or passed as environment variables / command-line arguments.

Global Configuration

Add these to your root Makefile (before include .rhiza/rhiza.mk) or local.mk:

# Override default Python version
PYTHON_VERSION = 3.12

# Override test coverage threshold (default: 90)
COVERAGE_FAIL_UNDER = 80

# Include the Rhiza API (template-managed)
include .rhiza/rhiza.mk

On-Demand Configuration

You can also pass variables directly to make for one-off commands:

# Run tests requiring only 80% coverage
make test COVERAGE_FAIL_UNDER=80

🎨 Documentation Customization

You can customize the API documentation and companion book.

Project Logo

The API documentation includes a logo in the sidebar. You can override the default logo (assets/rhiza-logo.svg) by setting the LOGO_FILE variable in your Makefile or local.mk:

LOGO_FILE := assets/my-custom-logo.png

Custom Templates

You can customize the look and feel of the API documentation by providing your own Jinja2 templates. Place your custom templates in the book/pdoc-templates directory.

For example, to override the main module template, create book/pdoc-templates/module.html.jinja2.

See the pdoc documentation on templates for full details on how to override specific parts of the documentation.

For more details on customizing the documentation, see book/README.md.

📖 Complete Documentation

For detailed information about extending and customizing the Makefile system, see .rhiza/make.d/README.md.