Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ardacetinkaya committed Oct 12, 2024
1 parent 9b77cf1 commit 6dec608
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 2 deletions.
Binary file added Example01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Summarize Pull Request

A simple GitHub action that can create a brief information about commits in a pull request(PR). So, within brief, initial description of commit changes helps reviewing the PR
A simple GitHub action that can create a brief information about commits in a pull request(PR). So, within brief, initial description of commit changes helps reviewing the PR.

![Image](/Example01.png)

## How

Expand All @@ -9,9 +11,36 @@ With Microsoft.Extensions.AI, action provides access to use LLMs such as GPT-4-0
- Azure AI Model Catalog - https://ai.azure.com/explore/models
- GitHub Models - https://github.com/marketplace/models

### Requierments
```yaml
name: Summarize PR

on:
pull_request:
branches: [ "main" ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Summarize PR Action
uses: ardacetinkaya/pull-request-action/@v1.0.0
env:
PAT: ${{ secrets.ACTION_TOKEN }}
APIKey: ${{ secrets.AI_API_KEY }}
ModelId: gpt-4o
RepositoryName: ${{github.event.repository.name}}
RepositoryAccount: ${{github.repository_owner}}
CommitSHA: ${{ github.event.pull_request.head.sha }}
PullRequestId: ${{github.event.number}}

```

### Requirements
1. Create an GitHub Access Token to be able to use GitHub Apis
- Read and write to pull request is required
2. Create required access key for LLM models
3. Create secrets for the above access assets in the GitHub repo.


## Why

Expand Down

0 comments on commit 6dec608

Please sign in to comment.