# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
site_name: ReleaseKit
site_description: >-
ReleaseKit — release orchestration for polyglot monorepo workspaces
supporting Python (uv), JavaScript (pnpm), Go, Dart, Java, Kotlin,
Clojure, Rust, and Bazel ecosystems.
site_url: https://firebase.github.io/genkit/releasekit/
repo_url: https://github.com/firebase/genkit
repo_name: firebase/genkit
edit_uri: edit/main/py/tools/releasekit/docs/docs/
copyright: Copyright © 2026 Google LLC
theme:
name: material
language: en
features:
- content.code.annotate
- content.code.copy
- content.tabs.link
- navigation.expand
- navigation.indexes
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: light blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: light blue
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Inter
code: JetBrains Mono
icon:
repo: fontawesome/brands/github
logo: material/package-variant-closed
plugins:
- search
- tags
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
extra_css:
- stylesheets/extra.css
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/firebase/genkit
generator: false
nav:
- Home: index.md
- Architecture:
- architecture/index.md
- Module Map: architecture/module-map.md
- Backend System: architecture/backends.md
- Dependency Graph: architecture/dependency-graph.md
- Scheduler: architecture/scheduler.md
- State Machine: architecture/state-machine.md
- Guides:
- guides/index.md
- "Beginner's Guide": guides/beginners-guide.md
- Getting Started:
- Getting Started: guides/getting-started.md
- Configuration: guides/configuration.md
- Per-Package Config: guides/per-package-config.md
- Multi-Ecosystem: guides/multi-ecosystem.md
- Release Groups: guides/groups.md
- Migration: guides/migration.md
- Versioning:
- Versioning Schemes: guides/versioning-schemes.md
- Release Channels: guides/channels.md
- Changesets: guides/changesets.md
- Snapshots & Pre-Releases: guides/snapshots.md
- Publishing:
- Publish Pipeline: guides/publish-pipeline.md
- Dependency Pinning: guides/dependency-pinning.md
- Lifecycle Hooks: guides/hooks.md
- Commit-Back PRs: guides/commitback.md
- Hotfix & Maintenance: guides/hotfix.md
- Rollback: guides/rollback.md
- Concurrency & Locking: guides/concurrency.md
- Announcements: guides/announcements.md
- Security & Compliance:
- Overview: guides/compliance.md
- Signing & Verification: guides/signing.md
- SLSA Provenance: guides/slsa-provenance.md
- SBOM Generation: guides/sbom.md
- Trust & Verification: guides/trust.md
- Vulnerability Scanning: guides/vulnerability-scanning.md
- OpenSSF Scorecard: guides/scorecard.md
- Security Insights: guides/security-insights.md
- CI/CD & Operations:
- CI/CD Integration: guides/ci-cd.md
- Starter Patterns: guides/workflow-templates.md
- Health Checks & Doctor: guides/health-checks.md
- Observability: guides/observability.md
- Skipping Checks: guides/skip-checks.md
- Troubleshooting:
- Error Codes: guides/error-codes.md
- FAQ: guides/faq.md
- Workflow Templates:
- guides/workflows/index.md
- Python (uv): guides/workflows/python-uv.md
- JavaScript (pnpm): guides/workflows/javascript-pnpm.md
- Go: guides/workflows/go.md
- Rust (Cargo): guides/workflows/rust-cargo.md
- Dart/Flutter: guides/workflows/dart-flutter.md
- Java/Kotlin (Gradle): guides/workflows/java-gradle.md
- Rollback: guides/workflows/rollback.md
- Reference:
- reference/index.md
- CLI Commands: reference/cli.md
- Configuration File: reference/config-file.md
- GitHub Action: reference/github-action.md
- Graph Formatters: reference/formatters.md
- Compliance API: reference/compliance-api.md
- Internals:
- internals/index.md
- Versioning Engine: internals/versioning.md
- Publisher Pipeline: internals/publisher.md
- Async & Concurrency: internals/async-concurrency.md
- Preflight Checks: internals/preflight.md
- Changelog Generation: internals/changelog.md
- Release Notes: internals/release-notes.md
- Tags & Releases: internals/tags.md
- License Data Verification: internals/license-data.md
- Planning:
- Roadmap: roadmap.md
- AI Release Notes Plan: ai-release-notes-plan.md
- Workflow Migration Plan: release-workflow-migration.md
- Competitive Gap Analysis: competitive-gap-analysis.md
- "Slide Deck \u2197": slides/index.html
