Skip to content
This repository has been archived by the owner on Mar 6, 2024. It is now read-only.

update default prompts to use release_notes instead of full summary #203

Merged
merged 2 commits into from
Apr 19, 2023

Conversation

harjotgill
Copy link
Contributor

@harjotgill harjotgill commented Apr 19, 2023

Summary by OpenAI

Release Notes

New Feature: The GitHub Action now extracts release notes from pull request descriptions instead of using the full summary. This improves the user experience by providing more relevant prompts for reviewers and ensures consistency across different pull requests.

Bug Fix: The review.ts file is updated to remove ">" characters from release notes.

Refactor: Several files are modified to use release notes as default prompts and include error handling and token count checks.

"Release notes extracted with ease,
Reviewers' prompts now aim to please.
Consistency and relevance abound,
With fewer bugs to be found."

@github-actions
Copy link
Contributor

github-actions bot commented Apr 19, 2023

🤖 OpenAI

Pull Request Review

This pull request updates the default prompts used in the GitHub Action to extract release notes from a pull request description instead of using the full summary. The changes include adding a new get_release_notes method to the commenter.ts file, updating the Inputs class in options.ts to include a new release_notes property, and modifying the handleReviewComment function in review-comment.ts to use release notes as default prompts. Additionally, the review.ts file is updated to remove ">" characters from release notes.

Overall, the changes seem to improve the user experience by providing more relevant prompts for reviewers while also improving the consistency of the prompts across different pull requests.

File Summary
action.yml No specific feedback or suggestions provided due to lack of information.
src/commenter.ts Adds a new method to extract release notes from PR description and returns an empty string if no release notes are found.
src/options.ts Adds a new release_notes property to the Inputs class and updates the default prompts to use it instead of summary.
src/review-comment.ts Modifies the handleReviewComment function to use release notes as default prompts and includes error handling and token count checks.
src/review.ts Updates the input prompt to use release notes instead of full summary and removes ">" characters from release notes.

Chat with 🤖 OpenAI Bot (@openai)

  • Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
  • Invite the bot into a review comment chain by tagging @openai in a reply.

Code suggestions

  • The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
  • You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Files ignored due to filter (1)

Ignored files

  • dist/index.js

action.yml Show resolved Hide resolved
action.yml Show resolved Hide resolved
@harjotgill harjotgill merged commit c236ecc into main Apr 19, 2023
@harjotgill harjotgill deleted the update_prompt_2 branch April 19, 2023 19:37
shoyuf pushed a commit to maybeLab/openai-mr-reviewer-gltlab that referenced this pull request Jun 25, 2023
…oderabbitai#203)

<!-- This is an auto-generated comment: release notes by openai -->
### Summary by OpenAI

**Release Notes**

New Feature: The GitHub Action now extracts release notes from pull
request descriptions instead of using the full summary. This improves
the user experience by providing more relevant prompts for reviewers and
ensures consistency across different pull requests.

Bug Fix: The `review.ts` file is updated to remove ">" characters from
release notes.

Refactor: Several files are modified to use release notes as default
prompts and include error handling and token count checks.

> "Release notes extracted with ease,  
> Reviewers' prompts now aim to please.  
> Consistency and relevance abound,  
> With fewer bugs to be found."
<!-- end of auto-generated comment: release notes by openai -->
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant