mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-13 05:49:06 +00:00
feat: add comprehensive security scanning and EditorConfig integration
- Add govulncheck, Snyk, and Trivy vulnerability scanning - Create security workflow for automated scanning on push/PR/schedule - Add gitleaks for secrets detection and prevention - Implement EditorConfig linting with eclint and editorconfig-checker - Update Makefile with security and formatting targets - Create SECURITY.md with vulnerability reporting guidelines - Configure Dependabot for automated dependency updates - Fix all EditorConfig violations across codebase - Update Go version to 1.23.10 to address stdlib vulnerabilities - Add tests for internal/helpers package (80% coverage) - Remove deprecated functions and migrate to error-returning patterns - Fix YAML indentation in test fixtures to resolve test failures
This commit is contained in:
77
testdata/example-action/README.md
vendored
77
testdata/example-action/README.md
vendored
@@ -1,37 +1,86 @@
|
||||
# Example Action
|
||||
|
||||
  
|
||||
|
||||
> Test Action for gh-action-readme
|
||||
|
||||
## Usage
|
||||
## 🚀 Quick Start
|
||||
|
||||
```yaml
|
||||
- uses: ivuorinen/gh-action-readme/example-action@v1
|
||||
with:
|
||||
input1: # First input (default: foo)
|
||||
input2: # Second input
|
||||
name: My Workflow
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Example Action
|
||||
uses: ivuorinen/gh-action-readme/example-action@v1
|
||||
with:
|
||||
input1: "foo"
|
||||
input2: "value"
|
||||
```
|
||||
|
||||
## Inputs
|
||||
|
||||
## 📥 Inputs
|
||||
|
||||
- **input1**: First input (**required**) (default: foo)
|
||||
|
||||
- **input2**: Second input
|
||||
| Parameter | Description | Required | Default |
|
||||
|-----------|-------------|----------|---------|
|
||||
| `input1` | First input | ✅ | `foo` |
|
||||
| `input2` | Second input | ❌ | - |
|
||||
|
||||
|
||||
|
||||
## Outputs
|
||||
## 📤 Outputs
|
||||
|
||||
| Parameter | Description |
|
||||
|-----------|-------------|
|
||||
| `result` | Result output |
|
||||
|
||||
|
||||
- **result**: Result output
|
||||
## 💡 Examples
|
||||
|
||||
<details>
|
||||
<summary>Basic Usage</summary>
|
||||
|
||||
```yaml
|
||||
- name: Example Action
|
||||
uses: ivuorinen/gh-action-readme/example-action@v1
|
||||
with:
|
||||
input1: "foo"
|
||||
input2: "example-value"
|
||||
```
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Advanced Configuration</summary>
|
||||
|
||||
```yaml
|
||||
- name: Example Action with custom settings
|
||||
uses: ivuorinen/gh-action-readme/example-action@v1
|
||||
with:
|
||||
input1: "foo"
|
||||
input2: "custom-value"
|
||||
```
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
## Example
|
||||
## 🔧 Development
|
||||
|
||||
See the [action.yml](./action.yml) for a full reference.
|
||||
See the [action.yml](./action.yml) for the complete action specification.
|
||||
|
||||
## 📄 License
|
||||
|
||||
This action is distributed under the MIT License. See [LICENSE](LICENSE) for more information.
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
|
||||
---
|
||||
|
||||
*Auto-generated by [gh-action-readme](https://github.com/ivuorinen/gh-action-readme)*
|
||||
<div align="center">
|
||||
<sub>🚀 Generated with <a href="https://github.com/ivuorinen/gh-action-readme">gh-action-readme</a></sub>
|
||||
</div>
|
||||
|
||||
1
testdata/example-action/action.yml
vendored
1
testdata/example-action/action.yml
vendored
@@ -17,4 +17,3 @@ runs:
|
||||
branding:
|
||||
icon: check
|
||||
color: green
|
||||
|
||||
|
||||
2
testdata/example-action/config.yaml
vendored
2
testdata/example-action/config.yaml
vendored
@@ -6,4 +6,4 @@ permissions:
|
||||
contents: read
|
||||
runs_on:
|
||||
- "ubuntu-latest"
|
||||
- "macos-latest"
|
||||
- "macos-latest"
|
||||
|
||||
Reference in New Issue
Block a user