mirror of
https://github.com/redis/redis.git
synced 2026-07-11 11:05:39 -04:00
4dd58caa7c
Some checks are pending
CI / test-ubuntu-latest (push) Waiting to run
CI / test-sanitizer-address (push) Waiting to run
CI / build-debian-old (push) Waiting to run
CI / build-macos-latest (push) Waiting to run
CI / build-32bit (push) Waiting to run
CI / build-libc-malloc (push) Waiting to run
CI / build-centos-jemalloc (push) Waiting to run
CI / build-old-chain-jemalloc (push) Waiting to run
Codecov / code-coverage (push) Waiting to run
External Server Tests / test-external-standalone (push) Waiting to run
External Server Tests / test-external-cluster (push) Waiting to run
External Server Tests / test-external-nodebug (push) Waiting to run
Spellcheck / Spellcheck (push) Waiting to run
## Summary Redis core and the external modules (Search, JSON, Bloom, TimeSeries) are currently built and released through separate flows, forcing anyone assembling a full distribution to juggle multiple repos, refs, build commands, and config files. This PR collapses that into one Redis-owned workflow: ```sh make modules-update # clone/refresh modules from modules/modules.yaml make bootstrap # install per-module build/test deps make build # build Redis core + selected modules make run # start redis-server with modules loaded make test all # run module test suites make tarball TAG=... # build a reproducible source bundle ``` ## What This Adds **1. Manifest-driven modules** — `modules/modules.yaml` is the single source of truth for bundled modules. Each entry pins `repo`/`ref` and defines its build artifact and runtime `loadmodule` path. Refs resolve dynamically (tag → branch → SHA, else fail). Current pins: RedisBloom `v8.9.81`, RediSearch `v8.9.82`, RedisJSON `v8.9.81`, RedisTimeSeries `v8.9.82`. **2. Central manifest parser** — `scripts/lib/manifest.sh` is the only YAML reader, usable both as a shell library and a CLI helper (via `modules/manifest.mk`). **3. Per-module stub Makefiles removed** — The `modules/redis*/Makefile` stubs are deleted; their data moves to `modules.yaml` and shared behavior to `modules/common.mk`. ## Make Workflow The root `Makefile` is now a thin dispatch layer over scripts in `scripts/`: | Target | Script | Purpose | |---|---|---| | `make build [args]` | `scripts/build.sh` | Build Redis core plus selected modules | | `make bootstrap [args]` | `scripts/bootstrap.sh` | Install per-module build/test prerequisites | | `make setup [args]` | `scripts/setup.sh` | Run module update plus bootstrap | | `make run [args]` | `scripts/run.sh` | Start Redis with selected modules loaded | | `make test [args]` | `scripts/test.sh` | Run Redis or module tests | | `make clean [args]` | `scripts/clean.sh` | Clean Redis and/or module outputs | | `make deploy [args]` | `scripts/deploy.sh` | Install Redis and module artifacts | | `make modules-update [args]` | `scripts/modules-update.sh` | Clone/refresh module sources from the manifest | | `make modules-shallow [args]` | `scripts/modules-shallow.sh` | Re-clone selected modules with shallow history | | `make sync-redis-conf [args]` | `scripts/sync-redis-conf.sh` | Regenerate managed module config | | `make tarball TAG=...` | `scripts/tarball.sh` | Create a reproducible Redis + modules source tarball | All accept module selectors: ```sh make build all # core + all modules make build redisjson # core + one module make run none # core only, no modules make test redisearch TEST='some:test:name' ``` ## Runtime Configuration Removes the hand-maintained `redis-full.conf` (which could drift from upstream). Config is now generated: `sync-redis-conf.sh` produces a managed Modules block appended to verbatim `redis.conf`, with `loadmodule` lines (active when built or `ASSUME_BUILT=1`) plus each module's `module.conf`. The generated file is git-ignored. ## Docker & Release - **`docker/Dockerfile.noble`** — Ubuntu 24.04 build env for core + modules (amd64/arm64). - **`scripts/tarball.sh`** — reproducible source bundle: archives core at `TAG`, clones modules at pinned refs, strips `.git`/build artifacts, generates config, and produces a deterministic gzip. `utils/releasetools/01_create_tarball.sh` now delegates to it. - **`post-release-automation.yml`** — builds the bundle on published releases, uploads it as artifact + release asset, and reports SHA256. ## Docs `modules/MODULES.md` (operator guide), `modules/README.md`, and `README.md` cover the manifest schema, Make targets, tarball flow, Docker env, and troubleshooting. ## Compatibility Notes - `BUILD_WITH_MODULES=yes` is replaced by `make build [redis|core|none|all|<module>...]`. - `redis-full.conf` is now generated and git-ignored. - Module clones live under `modules/<name>/src/` (git-ignored). - `vector-sets` is omitted — it already lives in-tree. - RediSearch builds with `LTO=1 REDISEARCH_GENERATE_HEADERS=0 INLINE_LSE_ATOMICS=0`. --------- Co-authored-by: debing.sun <debing.sun@redis.com>
82 lines
2.8 KiB
Bash
Executable file
82 lines
2.8 KiB
Bash
Executable file
#!/bin/sh
|
|
# bootstrap.sh — install per-module build/test prerequisites.
|
|
#
|
|
# Usage: scripts/bootstrap.sh [<name> ...|all|.|'*']
|
|
#
|
|
# Top-level entry point is `make bootstrap`. Dispatches to each cloned
|
|
# module's `make -C modules/<name>/src bootstrap` (the upstream module
|
|
# convention).
|
|
# Continues past failures, prints a summary, exits non-zero on any failure.
|
|
#
|
|
# Env: MAKE make binary (defaults to `make`)
|
|
# PIP_BREAK_SYSTEM_PACKAGES forced to 1
|
|
|
|
set -eu
|
|
|
|
SCRIPT_DIR="$(cd -- "$(dirname -- "$0")" && pwd)" || exit 1
|
|
. "$SCRIPT_DIR/lib/manifest.sh"
|
|
cd "$REPO_ROOT"
|
|
|
|
MAKE_BIN="${MAKE:-make}"
|
|
|
|
# Ensure sudo + python3 exist when running as root inside a slim container,
|
|
# matching the legacy Makefile recipe behaviour.
|
|
if [ "$(uname -s)" = "Linux" ] && [ "$(id -u)" -eq 0 ] && ! command -v sudo >/dev/null 2>&1; then
|
|
if command -v apt-get >/dev/null 2>&1; then
|
|
apt-get update -qq && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends sudo python3
|
|
elif command -v dnf >/dev/null 2>&1; then
|
|
dnf install -y sudo python3
|
|
elif command -v tdnf >/dev/null 2>&1; then
|
|
tdnf install -y sudo python3
|
|
elif command -v apk >/dev/null 2>&1; then
|
|
apk add --no-cache bash make git sudo python3
|
|
fi
|
|
fi
|
|
|
|
cloned="$(cloned_modules)"
|
|
selected="$(resolve_modules "$*" "$cloned")"
|
|
|
|
if [ -z "$selected" ]; then
|
|
echo "ERROR: no modules to install deps for (no modules/*/src with .git or .prepared)"
|
|
echo " run 'make modules-update all' or clone into modules/<name>/src"
|
|
exit 1
|
|
fi
|
|
|
|
echo "==> Installing deps for: $selected"
|
|
export PIP_BREAK_SYSTEM_PACKAGES=1
|
|
failed=""
|
|
for name in $selected; do
|
|
echo
|
|
echo "==> [deps] $name"
|
|
src_mk="modules/$name/src/Makefile"
|
|
if [ ! -f "$src_mk" ]; then
|
|
echo " !! SKIP: $src_mk does not exist"
|
|
echo " (the upstream clone may be incomplete; try 'make modules-update $name')"
|
|
failed="$failed $name"
|
|
continue
|
|
fi
|
|
# Per-module convention: the inner target is still called `bootstrap` —
|
|
# that's defined by each module's own Makefile, not by us.
|
|
if ! grep -qE '^bootstrap[[:space:]]*:' "$src_mk"; then
|
|
echo " !! SKIP: no 'bootstrap' target in $src_mk"
|
|
echo " Add one to the upstream Makefile, e.g.:"
|
|
echo " bootstrap:"
|
|
echo " ./sbin/setup"
|
|
echo " .PHONY: bootstrap"
|
|
echo " then commit & push to the module's repo."
|
|
failed="$failed $name"
|
|
continue
|
|
fi
|
|
if ! "$MAKE_BIN" -C "modules/$name/src" bootstrap; then
|
|
failed="$failed $name"
|
|
fi
|
|
done
|
|
|
|
echo
|
|
if [ -n "$failed" ]; then
|
|
echo "==> Deps install completed with FAILURES for:$failed"
|
|
echo " Re-run 'make bootstrap$failed' after fixing the issues above."
|
|
exit 1
|
|
fi
|
|
echo "==> Deps install complete for: $selected"
|
|
echo " Next: 'make build [<name>]' then 'make test [<name>]' or 'make run'."
|