mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-02 09:44:08 +00:00
Ismo Vuorinen
ce02d36929
- 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
87 lines
1.7 KiB
Markdown
87 lines
1.7 KiB
Markdown
# Example Action
|
|
|
|
  
|
|
|
|
> Test Action for gh-action-readme
|
|
|
|
## 🚀 Quick Start
|
|
|
|
```yaml
|
|
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
|
|
|
|
| Parameter | Description | Required | Default |
|
|
|-----------|-------------|----------|---------|
|
|
| `input1` | First input | ✅ | `foo` |
|
|
| `input2` | Second input | ❌ | - |
|
|
|
|
|
|
|
|
## 📤 Outputs
|
|
|
|
| Parameter | Description |
|
|
|-----------|-------------|
|
|
| `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>
|
|
|
|
|
|
|
|
## 🔧 Development
|
|
|
|
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.
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
<sub>🚀 Generated with <a href="https://github.com/ivuorinen/gh-action-readme">gh-action-readme</a></sub>
|
|
</div>
|