mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-05 16:45:31 +00:00
Ismo Vuorinen
3fbb608f9f
* 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
129 lines
3.0 KiB
Markdown
129 lines
3.0 KiB
Markdown
---
|
|
name: Performance issue
|
|
about: Report CLI performance problems or slow operations
|
|
title: '[PERF] '
|
|
labels: performance, bug
|
|
assignees: ivuorinen
|
|
|
|
---
|
|
|
|
**Performance problem**
|
|
Describe what operation is slower than expected.
|
|
|
|
**Operation details**
|
|
Which gh-action-readme operation is slow?
|
|
|
|
- [ ] `gen` - Single file generation
|
|
- [ ] `gen --recursive` - Batch processing
|
|
- [ ] `validate` - Action validation
|
|
- [ ] `deps` - Dependency analysis
|
|
- [ ] `config` - Configuration operations
|
|
- [ ] Startup time
|
|
- [ ] Other: ___________
|
|
|
|
**Command executed**
|
|
The exact command that exhibits performance issues:
|
|
|
|
```bash
|
|
gh-action-readme [your slow command here]
|
|
```
|
|
|
|
**Performance metrics**
|
|
Provide timing and resource usage information:
|
|
|
|
**Processing time:**
|
|
|
|
- Current time: ___ seconds/minutes
|
|
- Expected time: ___ seconds/minutes
|
|
- Acceptable time: ___ seconds/minutes
|
|
|
|
**Dataset size:**
|
|
|
|
- Number of action.yml files: ___
|
|
- Total size of files: ___ KB/MB
|
|
- Repository structure depth: ___ levels
|
|
- Largest action.yml size: ___ KB
|
|
|
|
**Resource usage observed:**
|
|
|
|
- Peak memory usage: ___ MB
|
|
- CPU usage: ___% sustained
|
|
- Disk I/O patterns: [heavy reads, heavy writes, mixed]
|
|
- Network requests: ___ (for dependency analysis)
|
|
|
|
## Environment information
|
|
|
|
- OS: [e.g. macOS 14.1, Ubuntu 22.04, Windows 11]
|
|
- Hardware: [e.g. MacBook Air M2, Intel i7, AWS EC2 t3.large]
|
|
- gh-action-readme version: [run `gh-action-readme version`]
|
|
- Go version: [run `go version`]
|
|
- Installation method: [binary, homebrew, go install, docker]
|
|
|
|
**Batch processing details (if applicable)**
|
|
For recursive or batch operations:
|
|
|
|
**Repository structure:**
|
|
|
|
```text
|
|
my-repo/
|
|
├── .github/workflows/ (__ files)
|
|
├── actions/
|
|
│ ├── action1/ (action.yml)
|
|
│ ├── action2/ (action.yml)
|
|
│ └── ... (__ more actions)
|
|
└── other directories...
|
|
```
|
|
|
|
**Processing pattern:**
|
|
|
|
- [ ] Single large repository
|
|
- [ ] Multiple small repositories
|
|
- [ ] Mixed sizes
|
|
- [ ] Deep directory nesting
|
|
- [ ] Many small action.yml files
|
|
- [ ] Few large action.yml files
|
|
|
|
**Configuration impact**
|
|
Settings that might affect performance:
|
|
|
|
**Flags used:**
|
|
|
|
- Theme: [github, gitlab, minimal, professional, default]
|
|
- Output format: [md, html, json, asciidoc]
|
|
- Verbose mode: [yes, no]
|
|
- Dependency analysis: [enabled, disabled]
|
|
|
|
**Configuration file settings:**
|
|
|
|
```yaml
|
|
# Paste relevant config that might impact performance
|
|
```
|
|
|
|
## Expected vs actual behavior
|
|
|
|
- **Expected**: Should process files in specified seconds
|
|
- **Actual**: Takes ___ seconds/minutes to complete
|
|
- **Comparison**: Other similar tools take ___ seconds
|
|
|
|
**Profiling data (if available)**
|
|
If you've run any profiling:
|
|
|
|
```text
|
|
# Paste CPU/memory profiling output
|
|
# Or performance monitoring results
|
|
```
|
|
|
|
**Workarounds**
|
|
Any workarounds you've found:
|
|
|
|
- Breaking into smaller batches
|
|
- Specific flag combinations
|
|
- Environment modifications
|
|
|
|
## Additional context
|
|
|
|
- Network conditions (for dependency analysis)
|
|
- Disk type (SSD, HDD, network storage)
|
|
- Concurrent operations running
|
|
- Time of day patterns (if applicable)
|