ivuorinen/gh-action-readme
1
0
Fork 0
mirror of https://github.com/ivuorinen/gh-action-readme.git synced 2026-02-11 15:48:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: test failures caused by GitHub Actions token masking, updates (#97)

Browse Source 
* Initial plan

* Fix test token masking issue in GitHub Actions

Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com>

* chore: update permissions, go version, linting

* fix(ci): ignore test tokens for gitleaks

* chore: add fetch-depth zero to all checkout actions

* fix(ci): pr-lint contents write permission

* [MegaLinter] Apply linters fixes

* chore: ignore and remove megalinter-reports

* fix: restore commitlint pre-commit hook to v9.24.0

Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com>
Co-authored-by: Ismo Vuorinen <ismo@ivuorinen.net>
This commit is contained in:
Copilot
2025-11-13 18:13:20 +02:00
committed by GitHub
parent f4222fb6f3
commit d09c7918cb
23 changed files with 89 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/api.md
View File

@@ -36,21 +36,21 @@ gh-action-readme gen [directory_or_file] [flags]
#### Output Options
| Flag | Short | Type | Default | Description |
|------|-------|------|---------|-------------|
| ------ | ------- | ------ | --------- | ------------- |
| `--output-format` | `-f` | string | `md` | Output format: md, html, json, asciidoc |
| `--output-dir` | `-o` | string | `.` | Output directory for generated files |
| `--output` | | string | | Custom output filename (overrides default naming) |
#### Theme Options
| Flag | Short | Type | Default | Description |
|------|-------|------|---------|-------------|
| `--theme` | `-t` | string | `default` | Theme: github, gitlab, minimal, professional, default |
| Flag | Short | Type | Default | Description |
| --------- | ----- | ------ | --------- | -------------------------------------------------------- |
| `--theme` | `-t` | string | `default` | Theme: github, gitlab, minimal, professional, default |
#### Processing Options
| Flag | Short | Type | Default | Description |
|------|-------|------|---------|-------------|
| ------ | ------- | ------ | --------- | ------------- |
| `--recursive` | `-r` | boolean | `false` | Search directories recursively for action.yml files |
| `--quiet` | `-q` | boolean | `false` | Suppress progress output |
| `--verbose` | `-v` | boolean | `false` | Enable verbose logging |
@@ -58,7 +58,7 @@ gh-action-readme gen [directory_or_file] [flags]
#### GitHub Integration
| Flag | Short | Type | Default | Description |
|------|-------|------|---------|-------------|
| ------ | ------- | ------ | --------- | ------------- |
| `--github-token` | | string | | GitHub personal access token (or use GITHUB_TOKEN env) |
| `--no-dependencies` | | boolean | `false` | Disable dependency analysis |
@@ -152,7 +152,7 @@ gh-action-readme validate [file_or_directory] [flags]
### Flags
| Flag | Short | Type | Default | Description |
|------|-------|------|---------|-------------|
| ------ | ------- | ------ | --------- | ------------- |
| `--verbose` | `-v` | boolean | `false` | Show detailed validation messages |
| `--quiet` | `-q` | boolean | `false` | Only show errors, suppress warnings |
| `--recursive` | `-r` | boolean | `false` | Validate recursively |
@@ -343,7 +343,7 @@ gh-action-readme help config wizard
These flags are available for all commands:
| Flag | Short | Type | Default | Description |
|------|-------|------|---------|-------------|
| ------ | ------- | ------ | --------- | ------------- |
| `--config` | | string | | Custom configuration file path |
| `--help` | `-h` | boolean | `false` | Show help for command |
| `--quiet` | `-q` | boolean | `false` | Suppress non-error output |
@@ -352,7 +352,7 @@ These flags are available for all commands:
## 📊 Exit Codes
| Code | Description |
|------|-------------|
| ------ | ------------- |
| `0` | Success |
| `1` | General error |
| `2` | Invalid arguments |