mirror of
https://github.com/ivuorinen/f2b.git
synced 2026-03-07 13:58:15 +00:00
fix: repair Renovate config, convert Makefile to go run, update GitHub Actions (#120)
* fix: repair Renovate config and convert Makefile to go run (#117) - Remove non-existent `github>renovatebot/presets:golang` preset that broke Renovate PR creation - Replace deprecated `fileMatch` with `managerFilePatterns` in customManagers - Rewrite regex to match new Makefile pattern (renovate comment above version variable assignment) - Fix `matchFileNames` glob pattern (`*.mk` -> `**/*.mk`) - Convert all tool invocations from `go install` + global binary to `go run tool@version` for reproducible builds - Convert npm global tools to `npx --yes` invocations - Remove `dev-deps` and `check-deps` targets (tools auto-download) - Add mdformat pre-commit hook with GFM support and config - Add `fmt-md` Makefile target for manual markdown formatting - Update local golangci-lint pre-commit hook to use `go run` - Apply golangci-lint v2.10.1 auto-fixes (fmt.Fprintf optimization) - Add nolint:gosec annotations for legitimate exec.Command usage - Exclude .serena/ from mdformat and megalinter - Add markdown indent_size=unset in .editorconfig for CommonMark compat * chore(deps): update GitHub Actions to latest versions - anthropics/claude-code-action: v1.0.34 -> v1.0.64 - actions/setup-go: v6.2.0 -> v6.3.0 - actions/upload-artifact: v6.0.0 -> v7.0.0 - goreleaser/goreleaser-action: v6.4.0 -> v7.0.0 - docker/login-action: v3.6.0 -> v3.7.0 - ivuorinen/actions: v2026.01.21 -> v2026.02.24 * fix: address code review feedback - Fix issue template YAML frontmatter (replace underscore separators with proper --- delimiters); exclude templates from mdformat - Replace string(rune(n)) with strconv.Itoa(n) in test files to produce deterministic numeric directory names instead of Unicode characters - Remove stale `make dev-deps` reference in README, replace with `make dev-setup` - Extract ban/unban format strings into shared.MetricsFmtBanOperations and shared.MetricsFmtUnbanOperations constants - Replace hardcoded coverage percentages in README with evergreen phrasing * fix: address round 2 code review feedback for PR #120 - Fix corrupted path traversal example in docs/security.md - Fix Renovate .mk regex to match nested paths (.*\.mk$) - Update checkmake pre-commit hook to v0.3.2 to match Makefile - Add sync.WaitGroup to unsynchronized goroutines in security tests - Fix fmt-md target to use pre-commit run mdformat - Pin markdownlint-cli2 to v0.21.0 in lint-md target - Standardize //nolint:gosec to // #nosec annotations for gosec CLI * fix(ci): install PyYAML dependency for PR lint workflow The pr-lint workflow uses ivuorinen/actions/pr-lint which internally calls validate-inputs running a Python script that imports yaml. Python was set up but PyYAML was never installed, causing ModuleNotFoundError at runtime. * fix: address round 3 code review feedback for PR #120 - Wrap Windows-style path traversal example in backtick code span so backslashes render literally in docs/security.md - Add Renovate-managed MARKDOWNLINT_CLI2_VERSION variable in Makefile to match the pattern used by all other tool versions
This commit is contained in:
GitHub
55
README.md
55
README.md
@@ -7,7 +7,7 @@ Built with Go, featuring automatic sudo privilege management, shell completion,
|
||||
[](https://golang.org/)
|
||||
[](https://github.com/ivuorinen/f2b/actions)
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
@@ -79,7 +79,7 @@ make build
|
||||
go build -ldflags "-X github.com/ivuorinen/f2b/cmd.version=1.2.3" -o f2b .
|
||||
```
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## ✨ Key Features
|
||||
|
||||
@@ -115,7 +115,7 @@ go build -ldflags "-X github.com/ivuorinen/f2b/cmd.version=1.2.3" -o f2b .
|
||||
- **Thread Safety**: Extensive race condition testing and protection
|
||||
- **Security Audit Trail**: Comprehensive logging of all privileged operations
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 📋 Usage Examples
|
||||
|
||||
@@ -190,7 +190,7 @@ f2b completion fish > ~/.config/fish/completions/f2b.fish
|
||||
f2b completion powershell | Out-String | Invoke-Expression
|
||||
```
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## ⚙️ Configuration
|
||||
|
||||
@@ -249,7 +249,7 @@ f2b logs sshd --limit 50 --format=json
|
||||
f2b --log-level=debug --log-file=/tmp/f2b-debug.log ban 192.168.1.100
|
||||
```
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 🔐 Security & Privileges
|
||||
|
||||
@@ -268,7 +268,7 @@ f2b is designed with security as a fundamental principle:
|
||||
For detailed security practices, threat model, and contribution security guidelines, see
|
||||
[docs/security.md](docs/security.md).
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 📖 Complete Command Reference
|
||||
|
||||
@@ -322,7 +322,7 @@ For convenience, most commands have short aliases:
|
||||
- `ban` → `banip`, `b`
|
||||
- `unban` → `unbanip`, `ub`
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
@@ -338,8 +338,8 @@ f2b is built as an **enterprise-grade** Go application following modern architec
|
||||
|
||||
### 📊 **Quality Metrics**
|
||||
|
||||
- **Test Coverage**: 76.8% (cmd/), 59.3% (fail2ban/) - Above industry standards
|
||||
- **Modern Testing**: Fluent testing framework reducing code duplication by 60-70%
|
||||
- **Test Coverage**: Comprehensive coverage across all packages - above industry standards
|
||||
- **Modern Testing**: Fluent testing framework with significant reduction in test duplication
|
||||
- **Security Testing**: 13 comprehensive attack vector test cases implemented
|
||||
- **Performance**: Context-aware operations with configurable timeouts and resource management
|
||||
|
||||
@@ -363,7 +363,7 @@ f2b is built as an **enterprise-grade** Go application following modern architec
|
||||
For detailed architecture information, implementation patterns, and extension guidelines,
|
||||
see [docs/architecture.md](docs/architecture.md).
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 🧪 Development & Testing
|
||||
|
||||
@@ -395,8 +395,7 @@ This project uses [pre-commit](https://pre-commit.com/) for unified linting and
|
||||
Install the development dependencies and hooks:
|
||||
|
||||
```bash
|
||||
make dev-deps
|
||||
make pre-commit-setup
|
||||
make dev-setup
|
||||
```
|
||||
|
||||
Run all linters:
|
||||
@@ -428,7 +427,7 @@ f2b logs-watch all --limit 20 | while read line; do
|
||||
done
|
||||
```
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 🚀 Releases
|
||||
|
||||
@@ -438,19 +437,19 @@ Releases are automated using [GoReleaser](https://goreleaser.com/). To create a
|
||||
|
||||
1. **Tag the release:**
|
||||
|
||||
```bash
|
||||
git tag -a v1.2.3 -m "Release v1.2.3"
|
||||
git push origin v1.2.3
|
||||
```
|
||||
```bash
|
||||
git tag -a v1.2.3 -m "Release v1.2.3"
|
||||
git push origin v1.2.3
|
||||
```
|
||||
|
||||
2. **GitHub Actions will automatically:**
|
||||
|
||||
- Build binaries for multiple platforms (Linux, macOS, Windows, BSD)
|
||||
- Create a GitHub release with changelog
|
||||
- Upload release artifacts
|
||||
- Build and push Docker images
|
||||
- Update Homebrew tap (if configured)
|
||||
- Generate .deb, .rpm, and .apk packages
|
||||
- Build binaries for multiple platforms (Linux, macOS, Windows, BSD)
|
||||
- Create a GitHub release with changelog
|
||||
- Upload release artifacts
|
||||
- Build and push Docker images
|
||||
- Update Homebrew tap (if configured)
|
||||
- Generate .deb, .rpm, and .apk packages
|
||||
|
||||
### Manual Release (Development)
|
||||
|
||||
@@ -476,7 +475,7 @@ Each release includes:
|
||||
- Docker images at `ghcr.io/ivuorinen/f2b` with architecture-specific tags
|
||||
- Linux packages (.deb, .rpm, .apk) for multiple architectures
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
@@ -500,25 +499,25 @@ Please see:
|
||||
- [docs/security.md](docs/security.md) - Security practices and guidelines
|
||||
- [docs/testing.md](docs/testing.md) - Testing strategies and patterns
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 📄 License
|
||||
|
||||
[MIT License](LICENSE.md).
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 👨💻 Author
|
||||
|
||||
**Ismo Vuorinen** ([@ivuorinen](https://github.com/ivuorinen))
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
## 🆘 Support
|
||||
|
||||
- 📝 [Open an issue](https://github.com/ivuorinen/f2b/issues)
|
||||
- 📖 [Read the FAQ](docs/faq.md)
|
||||
|
||||
---
|
||||
______________________________________________________________________
|
||||
|
||||
_Built with ❤️ and Go. Securing systems one ban at a time._
|
||||
|
||||
Reference in New Issue
Block a user