Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mlamina authored Apr 14, 2024
1 parent 1d98365 commit 7aa7f1f
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions replicator/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,46 @@
# Replicator Action

The `replicator` action is designed to automate the process of creating new files or code snippets based on existing templates with specified characteristics. This action can significantly streamline the development process by allowing for the quick replication of code or file structures with minimal manual intervention.
The `replicator` action is designed to automate the process of creating new files or code snippets based on existing templates with specified characteristics. This action can significantly streamline your development process by allowing for the quick replication of code or file structures with minimal manual intervention.

## Workflow Ideas

- **Template-based File Creation** Use a template path and characteristics to automatically generate files or code snippets.
- **Automate Code Snippets** Automatically create code snippets based on predefined templates and characteristics.
- **Custom File Generation** Use custom templates to generate new files with specific characteristics defined by the user.
- **Copy Writing Style** Apply the writing style of one document to another document
- **Component Copy Cat** Create a new component / module similar to an existing one
- **Idea Generator** Let AI look at existing codes and generate 1 new Github issue per idea

## Usage

To use the `replicator` action in your project, you'll need to include it in your GitHub workflow files. Specify the template path, result path, and characteristics of the result to configure the action for your specific needs.
To use the `replicator` action in your project, you'll need to include it in your GitHub workflow files. Specify the template, result path, and characteristics of the result to configure the action for your specific needs.

### Inputs

- `template`: (Required) Path to the template file or code snippet to replicate.
- `template`: (Required) A description of the code / text / files you want replicated
- `characteristics`: (Required) Characteristics of the result, described in natural language.
- `sdk-version`: (Optional) Specifies the PR Pilot SDK version to use. Default is `1.0.3`.
- `api-key`: (Required) Your API key for PR Pilot.

### Example Workflow

Here is an example that generates a new action based on the code of an existing action.

```yaml
name: Replicate Template
name: Smart Action Copy Cat

on:
workflow_dispatch:
inputs:
template:
description: 'Path to the template file or code snippet to replicate'
description: 'Path(s) to the action(s) to be replicated'
required: true
characteristics:
description: 'Characteristics of the result, described in natural language'
description: 'Characteristics of the new action, described in natural language'
required: true

jobs:
replicate:
runs-on: ubuntu-latest
steps:
- name: Replicate Template
- name: Replicate Smart Action
uses: PR-Pilot-AI/smart-actions/replicator@v1
with:
# API key for PR Pilot must be defined as a secret in the repository
Expand Down

0 comments on commit 7aa7f1f

Please sign in to comment.