Skip to content

Commit

Permalink
Update replicator documentation with image
Browse files Browse the repository at this point in the history
  • Loading branch information
mlamina committed Apr 14, 2024
1 parent 5895b0c commit 81b7891
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions replicator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,16 @@ To use the `replicator` action in your project, you'll need to include it in you

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

![Smart Action Copy Cat](./example.png)

```yaml
name: Smart Action Copy Cat

on:
workflow_dispatch:
inputs:
template:
description: 'Path(s) to the action(s) to be replicated'
action-path:
description: 'Path to the action to be used as example'
required: true
characteristics:
description: 'Characteristics of the new action, described in natural language'
Expand All @@ -46,6 +48,8 @@ jobs:
# API key for PR Pilot must be defined as a secret in the repository
api-key: ${{ secrets.PR_PILOT_API_KEY }}
# Inputs for the replicator action
template: ${{ github.event.inputs.template }}
template: |
ALL files in the directory:
${{ inputs.action-path }}
characteristics: ${{ github.event.inputs.characteristics }}
```
Binary file added replicator/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 81b7891

Please sign in to comment.