ivuorinen/gh-action-readme
1
0
Fork 0
mirror of https://github.com/ivuorinen/gh-action-readme.git synced 2026-02-14 05:49:29 +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

4
docs/COMMIT_MESSAGES.md
View File

@@ -4,7 +4,7 @@ This project follows [Conventional Commits](https://www.conventionalcommits.org/
## Format
```
```text
<type>(<scope>): <subject>
<body>
@@ -42,7 +42,7 @@ The subject contains a succinct description of the change:
### Examples
```
```text
feat: add support for AsciiDoc output format
fix: correct template rendering for empty descriptions
docs: update installation instructions

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 |

6
docs/configuration.md
View File

@@ -33,7 +33,7 @@ cache_ttl: 3600
### Core Settings
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| -------- | ------ | --------- | ------------- |
| `theme` | string | `default` | Default theme to use |
| `output_format` | string | `md` | Default output format |
| `output_dir` | string | `.` | Default output directory |
@@ -42,7 +42,7 @@ cache_ttl: 3600
### GitHub Integration
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| -------- | ------ | --------- | ------------- |
| `github_token` | string | `""` | GitHub personal access token |
| `dependencies_enabled` | boolean | `true` | Enable dependency analysis |
| `rate_limit_delay` | int | `1000` | Delay between API calls (ms) |
@@ -50,7 +50,7 @@ cache_ttl: 3600
### Performance Settings
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| -------- | ------ | --------- | ------------- |
| `cache_ttl` | int | `3600` | Cache TTL in seconds |
| `concurrent_requests` | int | `3` | Max concurrent GitHub API requests |
| `timeout` | int | `30` | Request timeout in seconds |

10
docs/themes.md
View File

@@ -92,7 +92,7 @@ gh-action-readme gen --theme default
## 🎯 Theme Comparison
| Feature | GitHub | GitLab | Minimal | Professional | Default |
|---------|--------|--------|---------|-------------|---------|
| --------- | -------- | -------- | --------- | ------------- | --------- |
| **Badges** | ✅ Rich | ✅ GitLab | ❌ None | ✅ Comprehensive | ❌ None |
| **TOC** | ✅ Yes | ✅ Yes | ❌ No | ✅ Advanced | ❌ No |
| **Examples** | ✅ GitHub | ✅ CI/CD | ✅ Basic | ✅ Comprehensive | ✅ Basic |
@@ -146,10 +146,10 @@ runs:
<details>
<summary>📋 Inputs</summary>
| Input | Description | Required | Default |
|-------|-------------|----------|---------|
| `aws-region` | AWS region to deploy to | Yes | `us-east-1` |
| `environment` | Deployment environment | No | `production` |
| Input | Description | Required | Default |
| ------------- | ------------------------ | -------- | ------------- |
| `aws-region` | AWS region to deploy to | Yes | `us-east-1` |
| `environment` | Deployment environment | No | `production` |
</details>
```

4
docs/usage.md
View File

@@ -147,7 +147,7 @@ gh-action-readme gen --output-format json --output api/action.json
## 📄 Output Formats
| Format | Description | Use Case | Extension |
|--------|-------------|----------|-----------|
| -------- | ------------- | ---------- | ----------- |
| **md** | Markdown (default) | GitHub README files | `.md` |
| **html** | Styled HTML | Web documentation | `.html` |
| **json** | Structured data | API integration | `.json` |
@@ -174,7 +174,7 @@ gh-action-readme gen --output-format asciidoc --output docs/action.adoc
See [themes.md](themes.md) for detailed theme documentation.
| Theme | Best For | Features |
|-------|----------|----------|
| ------- | ---------- | ---------- |
| **github** | GitHub marketplace | Badges, collapsible sections |
| **gitlab** | GitLab repositories | CI/CD examples |
| **minimal** | Simple actions | Clean, concise |