Skip to content

Commit

Permalink
refactor: rename action to pull-request-summary
Browse files Browse the repository at this point in the history
  • Loading branch information
remarkablemark committed Mar 2, 2025
1 parent c129944 commit 1378b2a
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 18 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,33 @@
# github-actions-composite-template
# pull-request-summary

[![version](https://badgen.net/github/release/remarkablemark/github-actions-composite-template)](https://github.com/remarkablemark/github-actions-composite-template/releases)
[![test](https://github.com/remarkablemark/github-actions-composite-template/actions/workflows/test.yml/badge.svg)](https://github.com/remarkablemark/github-actions-composite-template/actions/workflows/test.yml)
[![version](https://badgen.net/github/release/ai-action/pull-request-summary)](https://github.com/ai-action/pull-request-summary/releases)
[![test](https://github.com/ai-action/pull-request-summary/actions/workflows/test.yml/badge.svg)](https://github.com/ai-action/pull-request-summary/actions/workflows/test.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

⚙️ GitHub Actions Composite Template. Inspired by [remarkablemark/hello-world-composite-action](https://github.com/remarkablemark/hello-world-composite-action).
📝 GitHub Action that summarizes pull requests with AI (LLM).

## Quick Start

```yaml
# .github/workflows/github-actions-composite-template.yml
# .github/workflows/pr-summary.yml
on: push
jobs:
github-actions-composite-template:
pr-summary:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- name: GitHub Actions Composite Template
uses: remarkablemark/github-actions-composite-template@v1
- name: PR summary
uses: ai-action/pull-request-summary@v1
```
## Usage
**Basic:**
```yaml
- uses: remarkablemark/github-actions-composite-template@v1
- uses: ai-action/pull-request-summary@v1
```
See [action.yml](action.yml)
Expand All @@ -36,15 +39,11 @@ See [action.yml](action.yml)
**Optional**: The version. Defaults to `1.2.3`:

```yaml
- uses: remarkablemark/github-actions-composite-template@v1
- uses: ai-action/pull-request-summary@v1
with:
version: 1.2.3
```

## Contributions

Contributions are welcome! 👋

## License

[MIT](LICENSE)
11 changes: 7 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
name: github-actions-composite-template
description: GitHub Actions Composite Template
name: pull-request-summary
description: GitHub Action that reviews pull requests with AI (LLM)
author: remarkablemark

inputs:
version:
description: Description
required: false
default: 1.2.3

runs:
using: composite
steps:
- name: Print version
shell: bash
run: |
echo 'version: ${{ inputs.version }}'
branding:
icon: activity
color: white
icon: code
color: gray-dark

0 comments on commit 1378b2a

Please sign in to comment.