Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Update quick-task action with new characteristics #12

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions quick-task/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Quick-Task Action

The `quick-task` action is designed to execute a simple task described directly in the action's inputs. This allows for a straightforward execution of tasks without the need for detecting specific keywords or commands within commit messages.

## Usage

To use the `quick-task` action in your project, you'll need to include it in your GitHub workflow files. Simply define the task you wish to run in the action's inputs.

### Inputs

- `task-description`: (Required) The description of the task to run as-is.

### Example Workflow

```yaml
name: Execute Quick Task

on:
push:

jobs:
run-quick-task:
runs-on: ubuntu-latest
steps:
- name: Run Task
uses: PR-Pilot-AI/smart-actions/quick-task@v1
with:
# Description of the task to run
task-description: "Echo Hello World"
```
12 changes: 12 additions & 0 deletions quick-task/action.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: 'Quick Task'
description: 'Executes a simple task described in the action inputs'
inputs:
task-description:
description: 'The description of the task to run as-is'
required: true
runs:
using: 'composite'
steps:
- name: Run Task
run: ${{ inputs.task-description }}
shell: bash
Loading