Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/reviewer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ jobs:
with:
python-version: "3.12"
- name: Install umbra-reviewer
run: pip install "umbra-reviewer>=0.1.0"
# source-available (All Rights Reserved); install from source, not PyPI.
run: pip install "umbra-reviewer @ git+https://github.com/bkd-dotcom/umbra-reviewer@v0.1.0"
- name: Compute the PR diff
env:
BASE_SHA: ${{ github.event.pull_request.base.sha }}
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-hooks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# hooks:
# - id: umbra-guard
#
# Requires: pip install "umbra-core>=0.3.0"
# Requires: pip install "umbra-core @ git+https://github.com/bkd-dotcom/umbra-core@v0.5.3"
- id: umbra-guard
name: Umbra guard (contract scope check)
description: Block staged changes that fall outside .umbra/admission.yaml scope.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ a deterministic pre-action check that blocks changes falling outside your repo's

Part of the [Umbra platform](https://github.com/bkd-dotcom/umbra-umbrella).

> Prerequisite: `pip install "umbra-core>=0.3.0"` and a `.umbra/admission.yaml` in
> Prerequisite: `pip install "umbra-core @ git+https://github.com/bkd-dotcom/umbra-core@v0.5.3"` and a `.umbra/admission.yaml` in
> your repo (a conservative default applies without one).

## pre-commit
Expand Down
2 changes: 1 addition & 1 deletion demos/try-guard.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# .umbra/admission.yaml, showing forbidden paths/commands blocked and an in-scope
# path allowed. Deterministic (umbra-core), never the model.
#
# Requirements: bash, git, and `pip install "umbra-core>=0.3.0"`.
# Requirements: bash, git, and `pip install "umbra-core @ git+https://github.com/bkd-dotcom/umbra-core@v0.5.3"`.
#
# Usage: bash demos/try-guard.sh
set -euo pipefail
Expand Down
4 changes: 2 additions & 2 deletions universal/umbra-guard.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# or manually. It checks proposed file paths and/or a command against the repo's
# .umbra/admission.yaml and exits non-zero (blocking) on a violation.
#
# Requires: pip install "umbra-core>=0.3.0"
# Requires: pip install "umbra-core @ git+https://github.com/bkd-dotcom/umbra-core@v0.5.3"
#
# Usage:
# umbra-guard.sh --path src/app.py
Expand All @@ -17,7 +17,7 @@
set -euo pipefail

if ! command -v umbra >/dev/null 2>&1; then
echo "umbra-guard: umbra-core not installed. Run: pip install 'umbra-core>=0.3.0'" >&2
echo "umbra-guard: umbra-core not installed. Run: pip install 'umbra-core @ git+https://github.com/bkd-dotcom/umbra-core@v0.5.3'" >&2
# Fail open by default so this never blocks a commit unexpectedly; set
# UMBRA_GUARD_STRICT=1 to fail closed when umbra is missing.
[ "${UMBRA_GUARD_STRICT:-0}" = "1" ] && exit 1 || exit 0
Expand Down
Loading