upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/docs/how-to
AgeCommit message (Collapse)Author
2026-01-27Add orchestration script for migration analysis pipelineDanConwayDev
Adds run-migration-analysis.sh that orchestrates all 5 phases of the migration analysis with: - Parameterized inputs for relay URLs, git paths, and service name - Phase control (skip, only, from-phase options) - Dry-run mode to preview execution - Progress indicators and timing information - Error handling with continue-on-error option - Auto-detection of available features (git paths, journalctl) - Summary display with results overview
2026-01-27Add Phase 5 migration script for final classificationDanConwayDev
- Combines all data sources from Phases 1-4 - Produces three actionable outputs: no-action, action-required, manual-investigation - Generates comprehensive summary with recommendations - Handles missing Phase 4 logs gracefully - Classification logic for migration decision-making
2026-01-27Add Phase 4 migration scripts for log extractionDanConwayDev
- 30-extract-parse-failures.sh: Extracts parse failure events from logs - 31-extract-purgatory-expiry.sh: Extracts purgatory expiry events from logs - Both support time range filtering (--since, --until) - Includes dry-run mode for testing - Gracefully handles missing logs with dependency notes - TSV output format for Phase 5 consumption - Ready for when structured logging is implemented in ngit-grasp
2026-01-27Add Phase 2 migration script for git sync verificationDanConwayDev
- Compares state event refs to actual git data on disk - Uses git show-ref to handle both loose and packed refs - Outputs TSV format compatible with Phase 3 categorization - Optional --categorize flag for inline categorization - Includes progress indicators and ETA (~20 min runtime on VPS) - Improved error handling and validation over original script
2026-01-27Add Phase 3 migration scripts for categorization and comparisonDanConwayDev
- 20-categorize.sh: Categorizes git sync status into 4 categories - 21-compare-relays.sh: Compares prod vs archive to find gaps - Updated how-to doc with detailed Phase 3 outputs and directory structure - Tested with Jan 22 data: 231 complete in both, 276 complete in prod but missing from archive
2026-01-27Add Phase 1 migration script to fetch events from relayDanConwayDev
- Fetches kind 30618 (state), 30617 (announcement), 5 (deletion) events - Uses nak req --paginate for complete event retrieval - Outputs JSONL format for downstream processing - Includes error handling and timing information
2026-01-27docs: migration updateDanConwayDev
2026-01-27docs: add initial migration how-to with starter contentDanConwayDev
2026-01-12Change default port from 8080 to 7334 (NGIT on phone keypad)DanConwayDev
- Update default bind address in src/config.rs to 127.0.0.1:7334 - Update all four critical config sources per AGENTS.md: - src/config.rs (code default and tests) - .env.example (development template) - docs/reference/configuration.md (user documentation) - nix/module.nix (NixOS deployment) - Update all documentation examples and references: - README.md (with note about phone keypad mnemonic) - docs/how-to/*.md (deploy, prometheus-setup, test-compliance) - docs/explanation/*.md (architecture, comparison) - docs/learnings/grasp-audit.md Port 7334 spells NGIT on a phone keypad, making it memorable and project-specific. All tests pass (336 lib tests + 51 integration tests).
2026-01-11docs: add guide for updating git dependencies in CargoDanConwayDev
- Add new how-to guide covering hash updates for git dependencies - Applies to any git dependency (e.g., nostr-sdk fork) - Add critical note in AGENTS.md linking to this guide - Emphasize that hash updates in both flake.nix and nix/module.nix are MANDATORY
2026-01-11docs: add production deployment how-to guideDanConwayDev
- Complete guide for deploying ngit-grasp to NixOS servers - Step-by-step deployment instructions - Configuration options reference - Troubleshooting section - Security hardening recommendations - Multiple instance examples - References nix/example-configuration.nix which has clear examples
2026-01-10docs: update production sync testing to require 60 secondsDanConwayDev
The sync system uses a 5-second batch window for discovered repos. Repos discovered late in a 30-second test don't have enough time for the full Layer 2→3→4 cascade: - Layer 1: Discover repo announcements (0-5s) - Layer 2: Send #a, #A, #q filters for repos (5-30s) - Layer 3: Receive issues, patches, PRs (30-60s) - Layer 4: Receive comments on root events (40-60s) Testing confirmed that 60 seconds allows late-discovered repos (gitworkshop, ngit) to complete all layers, while 30 seconds only allows 1 second after Layer 2 filters are sent. Updated all references from 30s to 60s throughout the guide and added explanation of why this duration is necessary.
2026-01-10docs: save both raw and sanitized logs for flexible analysisDanConwayDev
- Update production sync testing workflow to save both sync-raw.log and sync.log - Raw log contains complete untruncated messages (rejection reasons, event data, etc.) - Sanitized log remains for quick scanning and pattern recognition - Add guidance on when to use each log and how to retrieve full details from raw log - Resolves truncated rejection warning issue by making full details accessible
2026-01-09docs: add permission step to fix mode workflowDanConwayDev
Mode 1 (Fix Existing Issues) now requires reviewing the proposed fix and asking for user permission before implementing changes. This ensures users have visibility and control over what code changes are made. Changes: - Added Step 3: Review Proposed Fix and Get Permission - Renumbered subsequent steps (4-7) - Updated both overview and detailed workflow sections - Updated workflow diagram to show review/permission steps
2026-01-09docs: update production sync testing workflow to two-mode processDanConwayDev
- Mode 1: Fix one existing issue, test, commit, report - Mode 2: Discover new issues with minimal documentation - Emphasize stopping after each cycle - Remove detailed investigation requirements - Simplify issue documentation format
2026-01-09docs: track production sync issues in work/active-issues/DanConwayDev
- Update production-sync-testing.md to document issues as individual markdown files in work/active-issues/ instead of polluting the tracked how-to guide - Add issue template and workflow for creating, viewing, and resolving issues - Document active-issues/ purpose in work/README.md - Prevents accidental commits of transient testing issues - Makes issue management cleaner and more focused
2026-01-09Fix production-sync-testing.md guide and sanitize-logs.sh scriptDanConwayDev
- Fix shebang in sanitize-logs.sh from #!/bin/bash to #!/usr/bin/env bash for NixOS compatibility - Update sanitizer defaults from 100/20 to 200/100 chars for better log readability - Fix CLI argument names in guide: --sync-bootstrap-relay -> --sync-bootstrap-relay-url - Fix CLI argument names in guide: --git-path -> --git-data-path These issues were discovered during first-time testing of the production sync testing guide.
2026-01-09docs: add production sync testing guide and log sanitizer scriptDanConwayDev
Add infrastructure for iterative debugging of sync against production data: - scripts/sanitize-logs.sh: Truncates verbose log lines for LLM analysis - docs/how-to/production-sync-testing.md: Step-by-step guide for testing sync against real relays, identifying issues, and improving logging
2025-12-04add prometheus metricsDanConwayDev
2025-11-04test: migrate to TestRelay fixture pattern and add compliance docsDanConwayDev
- Remove unnecessary 'nix' dev dependency (Unix syscalls crate, not needed) - Migrate announcement tests to new TestRelay fixture pattern - Delete legacy test files (announcement_tests.rs, test_relay.sh) - Add comprehensive test documentation (docs/how-to/test-compliance.md) - Update README.md with new test commands - All 18 integration tests passing (NIP-01 + NIP-34) Benefits: - Automatic relay lifecycle management - No manual setup required - Pure Rust integration tests - Better developer experience - CI/CD ready
2025-11-04docs: use Diátaxis structureDanConwayDev