Skip to content

Commit

Permalink
πŸ“š Update README with correct usage and example workflow
Browse files Browse the repository at this point in the history
πŸ”§ This commit enhances the README documentation for the Auto PR Action:

- πŸ”„ Updates the action usage example with the correct GitHub username (`yuri-val`)
- βž• Adds a comprehensive example workflow section
- πŸš€ Provides a ready-to-use `.github/workflows/auto-pr.yml` configuration
- πŸ”‘ Clarifies the use of `PAT_TOKEN` for authentication
- πŸ“ Improves overall documentation structure and readability

These changes will help users quickly understand how to implement and configure the Auto PR Action in their projects, reducing potential setup issues and improving adoption.
  • Loading branch information
yuri-val committed Oct 18, 2024
1 parent e7edbaa commit e7500f5
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To use this action in your workflow, add the following step:

```yaml
- name: Auto PR from Dev to Default
uses: your-github-username/auto-pr-action@v1
uses: yuri-val/auto-pr-action@v1
with:
openai_api_key: ${{ secrets.OPENAI_API_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -40,6 +40,31 @@ To use this action in your workflow, add the following step:
Make sure to set up the `OPENAI_API_KEY` secret in your repository settings.

### Example Workflow Using Your Custom Action

Create a workflow file in your repository (e.g., `.github/workflows/auto-pr.yml`):

```yml
name: Auto PR from dev to default
on:
push:
branches:
- dev
jobs:
auto-pr:
runs-on: ubuntu-latest
steps:
- name: Run Auto PR Action
uses: yuri-val/[email protected]
with:
openai_api_key: ${{ secrets.OPENAI_API_KEY }}
github_token: ${{ secrets.PAT_TOKEN }}
dev_branch: 'dev' # Optional, defaults to 'dev'
```

## How it works

1. Checks out the repository
Expand Down

0 comments on commit e7500f5

Please sign in to comment.