[New Feature] Public mirror setup — GitHub + Codeberg with hooks, CONTRIBUTING, CI, SECURITY #7

New issue

Closed

opened 2026-03-04 09:32:24 -08:00 by pyr0ball · 0 comments

pyr0ball commented

2026-03-04 09:32:24 -08:00

Owner

Overview

Design doc: docs/plans/2026-03-02-public-mirror-design.md
Plan doc: docs/plans/2026-03-02-public-mirror-plan.md

Set up GitHub and Codeberg mirrors with proper community infrastructure so Peregrine is ready for public engagement.

Scope

Pre-commit hook — sensitive file blocker (blocks .env, credentials, keys from being committed)
Git push mirrors — Forgejo push-mirrors to GitHub + Codeberg configured via web UI
Issue templates — Bug report, Feature Request, Support request (Forgejo + GitHub formats)
CONTRIBUTING.md — development setup, PR workflow, BSL 1.1 notice, CLA note
SECURITY.md — responsible disclosure, private reporting channel
GitHub Actions CI — pytest workflow on push/PR
setup.sh — activates git hooks on clone (git config core.hooksPath .githooks)

Notes

Full BSL 1.1 — no MIT carve-outs anywhere in the public mirror
Issue templates already partially committed (from earlier work)
GitHub Actions pytest workflow already committed (7e70771)

Acceptance Criteria

./setup.sh wires hooks on fresh clone
Pre-commit hook blocks known sensitive filenames and patterns
GitHub and Codeberg mirrors receive pushes automatically after Forgejo push
CONTRIBUTING and SECURITY docs present and accurate
CI runs and passes on both platforms

## Overview Design doc: `docs/plans/2026-03-02-public-mirror-design.md` Plan doc: `docs/plans/2026-03-02-public-mirror-plan.md` Set up GitHub and Codeberg mirrors with proper community infrastructure so Peregrine is ready for public engagement. ## Scope 1. **Pre-commit hook** — sensitive file blocker (blocks `.env`, credentials, keys from being committed) 2. **Git push mirrors** — Forgejo push-mirrors to GitHub + Codeberg configured via web UI 3. **Issue templates** — Bug report, Feature Request, Support request (Forgejo + GitHub formats) 4. **CONTRIBUTING.md** — development setup, PR workflow, BSL 1.1 notice, CLA note 5. **SECURITY.md** — responsible disclosure, private reporting channel 6. **GitHub Actions CI** — pytest workflow on push/PR 7. **setup.sh** — activates git hooks on clone (`git config core.hooksPath .githooks`) ## Notes - Full BSL 1.1 — no MIT carve-outs anywhere in the public mirror - Issue templates already partially committed (from earlier work) - GitHub Actions pytest workflow already committed (`7e70771`) ## Acceptance Criteria - `./setup.sh` wires hooks on fresh clone - Pre-commit hook blocks known sensitive filenames and patterns - GitHub and Codeberg mirrors receive pushes automatically after Forgejo push - CONTRIBUTING and SECURITY docs present and accurate - CI runs and passes on both platforms