Skip to content

Commit 1f074ff

Browse files
committed
Fixes on README
1 parent 3ed6e7a commit 1f074ff

4 files changed

Lines changed: 19 additions & 14 deletions

File tree

.github/workflows/recap.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
types: [opened]
66

77
jobs:
8-
stats:
8+
recap:
99
runs-on: ubuntu-latest
1010
steps:
1111
- name: Recap changes

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Changelog
22
All notable changes to this project will be documented in this file.
33

4-
## [1.0.0] - 2023-03-19
4+
## [1.0.1] - 2023-03-20
5+
### Added
6+
- Fixes on README.
7+
8+
## [1.0.0] - 2023-03-20
59
### Added
610
- First launch, with ♥ from Guadalajara, Mexico.

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# ⚡️ Recap
22

33
[![CI](https://github.com/flowwer-dev/recap/workflows/Tests/badge.svg)](https://github.com/flowwer-dev/recap/actions?query=workflow%3ATests)
4+
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Recap-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/pull-request-recap)
45

56
Tired of writing long pull request descriptions? or worse, not writing them at all?
67

7-
This Github action will summarize the most critical changes in a pull request using [GPT](https://openai.com/blog/chatgpt).
8+
This Github action will summarize the most significant changes in a pull request using [GPT](https://openai.com/blog/chatgpt).
89

910
The objective of this action is to:
1011

@@ -52,7 +53,7 @@ on:
5253
types: [opened]
5354
5455
jobs:
55-
stats:
56+
recap:
5657
runs-on: ubuntu-latest
5758
steps:
5859
- name: Recap changes
@@ -63,7 +64,7 @@ jobs:
6364

6465
This config will:
6566

66-
* Recap the most important changes included in the Pull Request.
67+
* Recap the most significant changes included in the Pull Request.
6768
* Post them as a comment.
6869

6970
## How the get an OpenAI API Key?
@@ -82,14 +83,14 @@ This config will:
8283

8384
```yml
8485
jobs:
85-
stats:
86-
runs-on: ubuntu-latest
87-
permissions:
88-
contents: read
89-
pull-requests: write
90-
steps:
91-
- name: Run pull request stats
92-
uses: flowwer-dev/pull-request-stats@main
86+
recap:
87+
runs-on: ubuntu-latest
88+
permissions:
89+
contents: read
90+
pull-requests: write
91+
steps:
92+
- name: Run pull request recap
93+
uses: flowwer-dev/recap@main
9394
```
9495
</details>
9596

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "recap",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "Github action to summarize the most important changes in a pull request",
55
"main": "dist/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)