thwap/ttheart

Watch

Fork 0

docs: add comprehensive README with quick start, config reference, and examples #191

Merged

fuzzy merged 2 commits from docs/add-comprehensive-readme into main

2026-07-06 09:14:35 +00:00

automation commented

2026-07-06 09:09:15 +00:00

Owner

What

Add comprehensive README.md covering:

Quick start guide for local and systemd deployment (#96)
Configuration reference with all options and field descriptions (#97)
Condition operator reference table (eq, ne, contains, matches, exists)
Action template function reference (json, timestamp, quote)
Example rules for 5 common Forgejo events (#98-#103):
- CI workflow failures (#98)
- Push events (#99)
- Issue creation/updates (#100)
- Pull request events (#101)
- Release events (#102)
Forgejo webhook setup guide (#104)
Troubleshooting guide (#105)
Environment variables and CLI flags reference
Build instructions with cross-compilation support

Why

Required for adoption. Users need clear docs to install, configure, and debug ttheart.

Testing

Unit tests pass — N/A (documentation only)
Integration tests pass — N/A
Manual testing performed — pre-commit pass, YAML validation pass
New tests added for new functionality — N/A

Breaking Changes

None.

Closes #106
Closes #96
Closes #97
Closes #103
Closes #98
Closes #99
Closes #100
Closes #101
Closes #102
Closes #104
Closes #105

## What Add comprehensive README.md covering: - Quick start guide for local and systemd deployment (#96) - Configuration reference with all options and field descriptions (#97) - Condition operator reference table (eq, ne, contains, matches, exists) - Action template function reference (json, timestamp, quote) - Example rules for 5 common Forgejo events (#98-#103): - CI workflow failures (#98) - Push events (#99) - Issue creation/updates (#100) - Pull request events (#101) - Release events (#102) - Forgejo webhook setup guide (#104) - Troubleshooting guide (#105) - Environment variables and CLI flags reference - Build instructions with cross-compilation support ## Why Required for adoption. Users need clear docs to install, configure, and debug ttheart. ## Testing - [ ] Unit tests pass — N/A (documentation only) - [ ] Integration tests pass — N/A - [x] Manual testing performed — pre-commit pass, YAML validation pass - [ ] New tests added for new functionality — N/A ## Breaking Changes None. Closes #106 Closes #96 Closes #97 Closes #103 Closes #98 Closes #99 Closes #100 Closes #101 Closes #102 Closes #104 Closes #105

automation added 2 commits

2026-07-06 09:09:16 +00:00

docs: add comprehensive README with quick start, config reference, and examples 4d053f3765

Covers:
- Quick start guide for local and systemd deployment
- Configuration reference with all options and field descriptions
- Condition operator reference (eq, ne, contains, matches, exists)
- Action template functions (json, timestamp, quote)
- Example rules for push, issues, pull_request, release, check_suite
- Forgejo webhook setup guide
- Troubleshooting guide
- Environment variables and CLI flags
- Build instructions with cross-compilation

Closes #96
Closes #97
Closes #98
Closes #99
Closes #100
Closes #101
Closes #102
Closes #103
Closes #104
Closes #105

docs: mark Write comprehensive documentation tasks as complete

CI / Pre-commit Hooks (pull_request) Successful in 2m33s

Details

CI / Lint (golangci-lint) (pull_request) Successful in 1m28s

Details

CI / Test (pull_request) Successful in 1m21s

Details

CI / Lint (golangci-lint) (push) Successful in 1m35s

Details

CI / Pre-commit Hooks (push) Successful in 2m30s

Details

CI / Test (push) Successful in 1m27s

Details

8eb5bd1e91

Closes #106

fuzzy scheduled this pull request to auto merge when all checks succeed

2026-07-06 09:10:13 +00:00

the.auditor approved these changes

2026-07-06 09:10:54 +00:00

the.auditor left a comment

Review

Comprehensive README covering all aspects of the project. Pre-commit hooks all pass.

Content verified against code:

Config fields, defaults, and types match the Go structs (listen :8080, max_concurrency 20, etc.)
Condition operators (eq, ne, contains, matches, exists) match the rule matcher
Template functions (json, timestamp, quote) match the executor
CLI flags (-config, -version) match main.go
Env vars (TTHEART_LISTEN, TTHEART_SECRET) match config.go
Quick start commands work with current codebase
Systemd setup matches ttheart.service
Example rules use real payload fields from Forgejo webhooks

Coverage: Quick start (local + systemd), full config reference, operator reference, template reference, 5 example rules, Forgejo setup guide, troubleshooting, env vars, CLI flags, build instructions.

No blocking issues.

APPROVED

## Review Comprehensive README covering all aspects of the project. Pre-commit hooks all pass. **Content verified against code**: - Config fields, defaults, and types match the Go structs (listen :8080, max_concurrency 20, etc.) - Condition operators (eq, ne, contains, matches, exists) match the rule matcher - Template functions (json, timestamp, quote) match the executor - CLI flags (-config, -version) match main.go - Env vars (TTHEART_LISTEN, TTHEART_SECRET) match config.go - Quick start commands work with current codebase - Systemd setup matches ttheart.service - Example rules use real payload fields from Forgejo webhooks **Coverage**: Quick start (local + systemd), full config reference, operator reference, template reference, 5 example rules, Forgejo setup guide, troubleshooting, env vars, CLI flags, build instructions. **No blocking issues.** **APPROVED**

fuzzy merged commit 8eb5bd1e91 into main

2026-07-06 09:14:35 +00:00

fuzzy deleted branch docs/add-comprehensive-readme

2026-07-06 09:14:35 +00:00