---
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.).