Makefile

# SPDX-License-Identifier: AGPL-3.0-or-later
# DockyPody: container build scripts and images
# Copyright (C) 2025 Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

.PHONY: help build build-push list-services validate-service
.PHONY: tls ca certs all clean tls.help
.PHONY: lint-docs lint-docs-fix

# Auto discover services in services/*.nuon files (using lib directly)
SERVICES := $(shell nu -c "use scripts/lib/services/core.nu list-service-names; list-service-names | str join ' '")

# Default build flags
PUSH ?= 0
LATEST ?= 1
PROVENANCE ?= 0
TAG ?=
EXTRA_TAG ?=
FILTER ?=

# Canonical CLI entry point
# Use: nu scripts/dockypody.nu <command> [options]

## Show this help message
help:
	@echo "Open Cloud Mesh Container Build System"
	@echo ""
	@echo "Canonical CLI: nu scripts/dockypody.nu help"
	@echo ""
	@echo "Available targets:"
	@echo "  build              Build all services (local, no push)"
	@echo "  build-push         Build and push all services to registries"
	@echo "  list-services      List all available services"
	@echo "  tls.help           Show TLS-oriented Make targets and options"
	@echo ""
	@echo "TLS-oriented Make targets:"
	@echo "  ca                 Generate the shared Certificate Authority (CA)"
	@echo "  certs              Generate certificates for TLS-enabled services"
	@echo "  all                Compatibility target: run TLS 'ca' then 'certs'"
	@echo "  clean              Compatibility target: remove TLS artifacts"
	@echo "  (You can prefix these with 'tls' for readability, for example 'make tls certs')"
	@echo "  (Run 'make tls.help' for detailed TLS options)"
	@echo ""
	@echo "Build a specific service:"
	@echo "  make build SERVICE=revad-base"
	@echo "  make build-push SERVICE=revad-base"
	@echo ""
	@echo "Build flags (can be combined):"
	@echo "  SERVICE=<name>     Service to build (default: build all)"
	@echo "  PUSH=1             Push to registries (default: 0)"
	@echo "  LATEST=1           Tag as latest (default: 1)"
	@echo "  PROVENANCE=1       Generate SBOM/provenance (default: 0)"
	@echo "  TAG=<tag>          Override version tag"
	@echo "  EXTRA_TAG=<tag>    Add extra tag"
	@echo ""
	@echo "Examples:"
	@echo "  make build                                    # Build all services locally"
	@echo "  make build SERVICE=revad-base                  # Build revad-base locally"
	@echo "  make build-push SERVICE=revad-base             # Build and push revad-base"
	@echo "  make build PUSH=1 PROVENANCE=1                # Build all with push and provenance"
	@echo "  make tls ca                                   # Generate shared CA"
	@echo "  make tls certs FILTER=revad-base,reva-gateway # Generate certs for selected services"
	@echo "  make tls all                                  # Generate CA and all certs"
	@echo "  make tls clean                                # Remove generated TLS artifacts"
	@echo ""
	@echo "Documentation linting:"
	@echo "  lint-docs                                     # Check documentation for writing rule violations"
	@echo "  lint-docs-fix                                 # Fix writing rule violations automatically"
	@echo ""

## List all available services
list-services:
	@echo "Available services:"
	@nu -c 'use scripts/lib/services/core.nu list-service-names; list-service-names | each { |s| print (["  - ", $$s] | str join "") }'
	@echo ""
	@nu -c 'use scripts/lib/services/core.nu list-service-names; print (["Total: ", (list-service-names | length | into string), " service(s)"] | str join "")'

## Validate SERVICE variable if provided
validate-service:
ifneq ($(SERVICE),)
	@nu -c 'use scripts/lib/services/core.nu [service-exists list-service-names]; if not (service-exists "$(SERVICE)") { print "Error: Service $(SERVICE) not found."; print ""; print "Available services:"; list-service-names | each { |s| print (["  - ", $$s] | str join "") }; exit 1 }'
endif

## Build service(s) locally or all if SERVICE not specified
build: validate-service
	@nu scripts/dockypody.nu build \
		$(if $(SERVICE),--service "$(SERVICE)",--all-services) \
		$(if $(filter 1,$(PUSH)),--push,) \
		$(if $(filter 1,$(LATEST)),--latest,) \
		$(if $(filter 1,$(PROVENANCE)),--provenance,) \
		$(if $(TAG),--version "$(TAG)",) \
		$(if $(EXTRA_TAG),--extra-tag "$(EXTRA_TAG)",)

## Build and push service(s) to registries
build-push: PUSH=1
build-push: build

## TLS namespace - silent no-op when used as prefix
tls:
	@:

## Show TLS help  
tls.help: tls
	@echo "TLS-oriented Make targets"
	@echo ""
	@echo "Available targets:"
	@echo "  make ca            Generate the shared Certificate Authority (CA)"
	@echo "  make certs         Generate certificates for TLS-enabled services"
	@echo "  make all           Compatibility target: run TLS 'ca' then 'certs'"
	@echo "  make clean         Compatibility target: remove TLS artifacts"
	@echo ""
	@echo "Readability aliases:"
	@echo "  make tls ca"
	@echo "  make tls certs"
	@echo "  make tls all"
	@echo "  make tls clean"
	@echo ""
	@echo "Options:"
	@echo "  FILTER=<service1,service2>  Passed to 'nu scripts/dockypody.nu tls certs --filter ...'"
	@echo ""
	@echo "For CLI-only TLS flags such as '--force', '--skip-shared-ca',"
	@echo "and '--keep-empty-dirs', use:"
	@echo "  nu scripts/dockypody.nu tls help"
	@echo ""
	@echo "Examples:"
	@echo "  make all"
	@echo "  make clean"
	@echo "  make tls certs FILTER=revad-base,reva-gateway"
	@echo ""

## Generate shared Certificate Authority
ca: tls
	@echo "Generating Certificate Authority..."
	@nu scripts/dockypody.nu tls ca

## Generate TLS certificates
## Usage: make tls certs FILTER="service1,service2"
certs: tls
	@echo "Generating TLS certificates..."
	@nu scripts/dockypody.nu tls certs $(if $(FILTER),--filter "$(FILTER)",)

## Generate CA and all certificates
all: tls ca certs

## Clean up generated certificates
clean: tls
	@nu scripts/dockypody.nu tls clean

## Lint documentation files for writing rule violations
lint-docs:
	@nu scripts/dockypody.nu docs lint

## Lint and fix documentation files
lint-docs-fix:
	@nu scripts/dockypody.nu docs lint --fix