feat: update go version, renovate config, tooling, fixes (#28)

* feat(deps): update go version, renovate config, tooling

* chore(deps): update google/go-github to v74

* feat(deps): migrate from yaml.v3 to goccy/go-yaml

* chore(deps): update goccy/go-yaml to v1.18.0 and address security concerns

* feat: improve issue templates and project configuration

- Update GitHub issue templates with CLI-specific fields for better bug reports
- Add specialized templates for documentation, theme, and performance issues
- Update pre-commit config to include comprehensive documentation linting
- Remove outdated Snyk configuration and security references
- Update Go version from 1.23+ to 1.24+ across project
- Streamline README.md organization and improve clarity
- Update CHANGELOG.md and CLAUDE.md formatting
- Create comprehensive CONTRIBUTING.md with development guidelines
- Remove TODO.md (replaced by docs/roadmap.md)
- Move SECURITY.md to docs/security.md

* docs: fix markdown linting violations across documentation

* fix: resolve template placeholder issues and improve uses statement generation

* fix: remove trailing whitespace from GitHub issue template
This commit is contained in:
2025-08-07 05:22:44 +03:00
committed by GitHub
parent b80ecfce92
commit 3fbb608f9f
49 changed files with 3235 additions and 1100 deletions

View File

@@ -7,6 +7,7 @@
**NEVER overwrite `/README.md`** - The root README.md is the main project documentation.
**For testing generation commands:**
```bash
# New enhanced targeting (recommended)
gh-action-readme gen testdata/example-action/
@@ -20,6 +21,7 @@ cd testdata/
## 🏗️ Architecture
**Core Components:**
- `main.go` - CLI with Cobra framework, enhanced gen command
- `internal/generator.go` - Core generation logic with custom output paths
- `internal/config.go` - Viper configuration (XDG compliant)
@@ -30,6 +32,7 @@ cd testdata/
- `internal/progress.go` - Progress indicators for batch operations
**Templates:**
- `templates/readme.tmpl` - Default template
- `templates/themes/` - Theme-specific templates
- `github/` - GitHub-style with badges
@@ -41,6 +44,7 @@ cd testdata/
## 🛠️ Commands & Usage
**Available Commands:**
```bash
gh-action-readme gen [directory_or_file] [flags] # Generate documentation
gh-action-readme validate # Validate action.yml files
@@ -50,6 +54,7 @@ gh-action-readme about # About tool
```
**Key Flags:**
- `--theme` - Select template theme
- `--output-format` - Choose format (md, html, json, asciidoc)
- `--output` - Custom output filename
@@ -62,8 +67,10 @@ gh-action-readme about # About tool
**Build:** `go build .`
**Test:** `go test ./internal`
**Lint:** `golangci-lint run`
**Dependencies:** `make deps-check` / `make deps-update`
**Testing Generation (SAFE):**
```bash
# Enhanced targeting (recommended)
gh-action-readme gen testdata/example-action/ --theme github --output test-output.md
@@ -94,6 +101,7 @@ cd testdata/example-action/
## 🎨 Themes
**Available Themes:**
1. **default** - Original simple template
2. **github** - Badges, tables, collapsible sections
3. **gitlab** - GitLab CI/CD examples
@@ -103,6 +111,7 @@ cd testdata/example-action/
## 📄 Output Formats
**Supported Formats:**
- **md** - Markdown (default)
- **html** - HTML with styling
- **json** - Structured data for APIs
@@ -115,6 +124,7 @@ cd testdata/example-action/
**Templates:** Test with `testdata/example-action/`
**Test Commands:**
```bash
# Core functionality (enhanced)
gh-action-readme gen testdata/example-action/
@@ -137,18 +147,21 @@ gh-action-readme gen testdata/ --recursive --theme professional
## 🚀 Production Features
**Configuration:**
- XDG Base Directory compliant
- Environment variable support
- Theme persistence
- Multiple search paths
**Error Handling:**
- Colored error messages
- Actionable suggestions
- Context-aware validation
- Graceful fallbacks
**Performance:**
- Progress bars for batch operations
- Thread-safe fixture caching with RWMutex
- Binary-relative template paths
@@ -160,11 +173,13 @@ gh-action-readme gen testdata/ --recursive --theme professional
## 🔄 Adding New Features
**New Theme:**
1. Create `templates/themes/THEME_NAME/readme.tmpl`
2. Add to `resolveThemeTemplate()` in `config.go:67`
3. Update `configThemesHandler()` in `main.go:284`
**New Output Format:**
1. Add constant to `generator.go:14`
2. Add case to `GenerateFromFile()` switch `generator.go:67`
3. Implement `generate[FORMAT]()` method
@@ -173,15 +188,40 @@ gh-action-readme gen testdata/ --recursive --theme professional
**New Template Functions:**
Add to `templateFuncs()` in `internal_template.go:19`
## 📦 Dependency Management
**Check for updates:**
```bash
make deps-check # Show outdated dependencies
```
**Update dependencies:**
```bash
make deps-update # Interactive updates with go-mod-upgrade
make deps-update-all # Update all to latest versions
```
**Automated updates:**
- Renovate bot runs weekly on Mondays at 4am UTC
- Creates PRs for minor/patch updates (auto-merge enabled)
- Major updates disabled (require manual review)
- Groups golang.org/x packages together
- Runs `go mod tidy` after updates
---
**Status: ENTERPRISE READY ✅**
*Enhanced gen command, thread-safety, comprehensive testing, and enterprise features fully implemented.*
**Latest Updates (August 6, 2025):**
- ✅ Enhanced gen command with directory/file targeting
- ✅ Custom output filename support (`--output` flag)
- ✅ Thread-safe fixture management with race condition protection
- ✅ GitHub Actions workflow integration with new capabilities
- ✅ Complete linting and code quality compliance
- ✅ Zero known race conditions or threading issues
- ✅ Dependency management automation with Renovate and go-mod-upgrade