mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-06 14:46:24 +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
69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
---
|
|
name: Bug report
|
|
about: Report a bug with gh-action-readme CLI tool
|
|
title: '[BUG] '
|
|
labels: bug
|
|
assignees: ivuorinen
|
|
|
|
---
|
|
|
|
**Describe the bug**
|
|
A clear and concise description of what the bug is.
|
|
|
|
**Command executed**
|
|
The exact gh-action-readme command that caused the issue:
|
|
|
|
```bash
|
|
gh-action-readme [your command here]
|
|
```
|
|
|
|
**Expected behavior**
|
|
Describe what you expected to happen.
|
|
|
|
**Actual behavior**
|
|
Describe what actually happened instead.
|
|
|
|
**Sample action.yml**
|
|
Provide the action.yml content that causes the issue (anonymize sensitive data):
|
|
|
|
```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 (configuration files, special setup, etc.).
|