mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-06 21:46:34 +00:00
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:
GitHub
72
.github/ISSUE_TEMPLATE/bug_report.md
vendored
72
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,7 +1,7 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
about: Report a bug with gh-action-readme CLI tool
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ivuorinen
|
||||
|
||||
@@ -10,29 +10,59 @@ assignees: ivuorinen
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
**Command executed**
|
||||
The exact gh-action-readme command that caused the issue:
|
||||
|
||||
```bash
|
||||
gh-action-readme [your command here]
|
||||
```
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
Describe what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
**Actual behavior**
|
||||
Describe what actually happened instead.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
**Sample action.yml**
|
||||
Provide the action.yml content that causes the issue (anonymize sensitive data):
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
```yaml
|
||||
# Paste your action.yml content here
|
||||
```
|
||||
|
||||
**Generated output (if applicable)**
|
||||
If documentation was generated, paste the problematic output:
|
||||
|
||||
```markdown
|
||||
# Paste generated documentation excerpt here
|
||||
```
|
||||
|
||||
## Environment information
|
||||
|
||||
- OS: [e.g. macOS 14.1, Ubuntu 22.04, Windows 11]
|
||||
- gh-action-readme version: [run `gh-action-readme version`]
|
||||
- Go version: [run `go version`]
|
||||
- Installation method: [binary, homebrew, go install, docker]
|
||||
- Theme used: [github, gitlab, minimal, professional, default]
|
||||
- Output format: [md, html, json, asciidoc]
|
||||
|
||||
**Repository structure (if relevant)**
|
||||
If the issue is related to file discovery or recursive processing:
|
||||
|
||||
```text
|
||||
my-repo/
|
||||
├── action.yml
|
||||
├── .github/
|
||||
│ └── workflows/
|
||||
└── other files...
|
||||
```
|
||||
|
||||
**Error messages**
|
||||
Paste any error messages or logs:
|
||||
|
||||
```text
|
||||
[paste error output here]
|
||||
```
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
Add any other context about the problem here (configuration files, special setup, etc.).
|
||||
|
||||
63
.github/ISSUE_TEMPLATE/documentation_issue.md
vendored
Normal file
63
.github/ISSUE_TEMPLATE/documentation_issue.md
vendored
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
name: Documentation quality issue
|
||||
about: Report problems with generated documentation output
|
||||
title: '[DOCS] '
|
||||
labels: documentation, quality
|
||||
assignees: ivuorinen
|
||||
|
||||
---
|
||||
|
||||
**Describe the documentation issue**
|
||||
A clear description of what's wrong with the generated documentation.
|
||||
|
||||
## Theme and format used
|
||||
|
||||
- Theme: [github, gitlab, minimal, professional, default]
|
||||
- Output format: [md, html, json, asciidoc]
|
||||
- Command used: `gh-action-readme gen [your flags here]`
|
||||
|
||||
**Sample action.yml**
|
||||
The action.yml input that produces the problematic documentation:
|
||||
|
||||
```yaml
|
||||
# Paste your action.yml content here
|
||||
```
|
||||
|
||||
**Current generated output**
|
||||
The problematic documentation that was generated:
|
||||
|
||||
```markdown
|
||||
# Paste the current output here (or relevant excerpt)
|
||||
```
|
||||
|
||||
**Expected documentation**
|
||||
What the documentation should look like instead:
|
||||
|
||||
```markdown
|
||||
# Paste what you expected here
|
||||
```
|
||||
|
||||
**Issue category**
|
||||
What type of documentation problem is this?
|
||||
|
||||
- [ ] Missing information (inputs, outputs, etc.)
|
||||
- [ ] Incorrect formatting/rendering
|
||||
- [ ] Broken links or references
|
||||
- [ ] Poor table layout
|
||||
- [ ] Badge/shield issues
|
||||
- [ ] Code block formatting
|
||||
- [ ] Template logic error
|
||||
- [ ] Theme-specific styling problem
|
||||
- [ ] Other: ___________
|
||||
|
||||
## Environment information
|
||||
|
||||
- OS: [e.g. macOS 14.1, Ubuntu 22.04, Windows 11]
|
||||
- gh-action-readme version: [run `gh-action-readme version`]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the documentation quality issue. Include:
|
||||
|
||||
- Screenshots if it's a visual formatting problem
|
||||
- Links to similar actions with good documentation
|
||||
- Specific markdown/HTML sections that are problematic
|
||||
60
.github/ISSUE_TEMPLATE/feature_request.md
vendored
60
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,20 +1,66 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
about: Suggest an enhancement for gh-action-readme
|
||||
title: '[FEATURE] '
|
||||
labels: enhancement
|
||||
assignees: ivuorinen
|
||||
|
||||
---
|
||||
|
||||
**Feature category**
|
||||
What type of enhancement is this?
|
||||
|
||||
- [ ] New theme
|
||||
- [ ] New output format
|
||||
- [ ] CLI command enhancement
|
||||
- [ ] Validation improvement
|
||||
- [ ] Configuration option
|
||||
- [ ] Template customization
|
||||
- [ ] Performance optimization
|
||||
- [ ] Integration (CI/CD, tools)
|
||||
- [ ] Other: ___________
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
Describe the current limitation or friction in your GitHub Actions documentation workflow.
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
A clear description of the desired functionality. Include:
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
- Proposed CLI syntax (if applicable)
|
||||
- Expected behavior
|
||||
- Sample input/output
|
||||
|
||||
**Use case and impact**
|
||||
Describe your specific GitHub Actions documentation scenario:
|
||||
|
||||
- What types of actions would benefit?
|
||||
- How many action.yml files does this affect?
|
||||
- What workflow improvement would this provide?
|
||||
|
||||
**Proposed implementation**
|
||||
If you have ideas about implementation:
|
||||
|
||||
- New CLI flags: `--flag-name`
|
||||
- Configuration options
|
||||
- Template modifications
|
||||
- Integration points
|
||||
|
||||
**Sample action.yml**
|
||||
Provide a sample action.yml that would showcase this feature:
|
||||
|
||||
```yaml
|
||||
# Example action.yml that would benefit from this feature
|
||||
```
|
||||
|
||||
**Expected output**
|
||||
Show what the generated documentation should look like:
|
||||
|
||||
```markdown
|
||||
# Expected documentation output
|
||||
```
|
||||
|
||||
**Alternatives considered**
|
||||
Describe alternative solutions or workarounds you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
Add any other context, mockups, or examples about the feature request.
|
||||
|
||||
128
.github/ISSUE_TEMPLATE/performance_issue.md
vendored
Normal file
128
.github/ISSUE_TEMPLATE/performance_issue.md
vendored
Normal file
@@ -0,0 +1,128 @@
|
||||
---
|
||||
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)
|
||||
113
.github/ISSUE_TEMPLATE/theme_request.md
vendored
Normal file
113
.github/ISSUE_TEMPLATE/theme_request.md
vendored
Normal file
@@ -0,0 +1,113 @@
|
||||
---
|
||||
name: Theme request
|
||||
about: Request a new theme or theme improvements
|
||||
title: '[THEME] '
|
||||
labels: enhancement, theme
|
||||
assignees: ivuorinen
|
||||
|
||||
---
|
||||
|
||||
**Theme request type**
|
||||
What kind of theme enhancement is this?
|
||||
|
||||
- [ ] New theme for a specific platform/use case
|
||||
- [ ] Improvements to existing theme
|
||||
- [ ] Theme bug fix
|
||||
- [ ] Theme customization options
|
||||
|
||||
**Target platform/use case**
|
||||
What platform or scenario is this theme designed for?
|
||||
|
||||
- [ ] GitHub Marketplace optimization
|
||||
- [ ] GitLab CI/CD documentation
|
||||
- [ ] Azure DevOps integration
|
||||
- [ ] Internal/Enterprise documentation
|
||||
- [ ] Minimal/lightweight documentation
|
||||
- [ ] Mobile-friendly documentation
|
||||
- [ ] Other: ___________
|
||||
|
||||
**Visual requirements**
|
||||
Describe the desired appearance and formatting:
|
||||
|
||||
**Badges and shields:**
|
||||
|
||||
- [ ] Platform-specific badges
|
||||
- [ ] Version/release shields
|
||||
- [ ] Build status badges
|
||||
- [ ] License/security badges
|
||||
- [ ] Custom badge styling
|
||||
|
||||
**Layout preferences:**
|
||||
|
||||
- [ ] Table of contents
|
||||
- [ ] Collapsible sections
|
||||
- [ ] Multi-column layout
|
||||
- [ ] Sidebar navigation
|
||||
- [ ] Card-based layout
|
||||
- [ ] Minimal typography
|
||||
|
||||
**Color scheme:**
|
||||
|
||||
- [ ] Dark theme
|
||||
- [ ] Light theme
|
||||
- [ ] Platform-specific colors (GitHub green, GitLab orange, etc.)
|
||||
- [ ] Corporate/brand colors
|
||||
- [ ] High contrast for accessibility
|
||||
|
||||
**Sample action.yml files**
|
||||
Provide example action.yml files to test the theme with:
|
||||
|
||||
```yaml
|
||||
# Example 1: Simple action
|
||||
name: Simple Action
|
||||
description: A basic action example
|
||||
inputs:
|
||||
input1:
|
||||
description: First input
|
||||
required: true
|
||||
outputs:
|
||||
output1:
|
||||
description: First output
|
||||
runs:
|
||||
using: node20
|
||||
main: index.js
|
||||
```
|
||||
|
||||
```yaml
|
||||
# Example 2: Complex action (if applicable)
|
||||
# Add more complex action.yml if theme needs to handle advanced cases
|
||||
```
|
||||
|
||||
**Reference examples**
|
||||
Provide links or descriptions of documentation that exemplifies the desired style:
|
||||
|
||||
- [ ] Link to well-styled action documentation
|
||||
- [ ] Screenshots of desired layout
|
||||
- [ ] Reference to design system or style guide
|
||||
- [ ] Examples from other tools/platforms
|
||||
|
||||
**Expected output preview**
|
||||
Mock up what the generated documentation should look like:
|
||||
|
||||
```markdown
|
||||
# Show expected theme output here
|
||||
# Include formatting, badges, layout structure
|
||||
```
|
||||
|
||||
**Existing theme starting point**
|
||||
Which existing theme should this be based on?
|
||||
|
||||
- [ ] Start from scratch
|
||||
- [ ] Extend `github` theme
|
||||
- [ ] Extend `gitlab` theme
|
||||
- [ ] Extend `minimal` theme
|
||||
- [ ] Extend `professional` theme
|
||||
- [ ] Extend `default` theme
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the theme request:
|
||||
|
||||
- Specific markdown features needed
|
||||
- Integration requirements
|
||||
- Performance considerations
|
||||
- Accessibility requirements
|
||||
55
.github/renovate.json
vendored
55
.github/renovate.json
vendored
@@ -1,6 +1,57 @@
|
||||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": [
|
||||
"github>ivuorinen/renovate-config"
|
||||
]
|
||||
"github>ivuorinen/renovate-config",
|
||||
"config:recommended"
|
||||
],
|
||||
"labels": [
|
||||
"dependencies"
|
||||
],
|
||||
"assigneesFromCodeOwners": true,
|
||||
"reviewersFromCodeOwners": true,
|
||||
"semanticCommits": "enabled",
|
||||
"semanticCommitType": "chore",
|
||||
"semanticCommitScope": "deps",
|
||||
"postUpdateOptions": [
|
||||
"gomodTidy"
|
||||
],
|
||||
"golang": {
|
||||
"enabled": true,
|
||||
"gomodUpdateImportPaths": true
|
||||
},
|
||||
"packageRules": [
|
||||
{
|
||||
"matchDatasources": [
|
||||
"go"
|
||||
],
|
||||
"matchUpdateTypes": [
|
||||
"major"
|
||||
],
|
||||
"enabled": false
|
||||
},
|
||||
{
|
||||
"matchDatasources": [
|
||||
"go"
|
||||
],
|
||||
"matchUpdateTypes": [
|
||||
"minor",
|
||||
"patch"
|
||||
],
|
||||
"automerge": true,
|
||||
"automergeType": "pr",
|
||||
"requiredStatusChecks": null
|
||||
},
|
||||
{
|
||||
"matchPackagePatterns": [
|
||||
"^golang.org/x/"
|
||||
],
|
||||
"groupName": "golang.org/x packages"
|
||||
}
|
||||
],
|
||||
"schedule": [
|
||||
"before 4am on monday"
|
||||
],
|
||||
"timezone": "UTC",
|
||||
"prConcurrentLimit": 3,
|
||||
"prHourlyLimit": 2
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user