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

provide short summary when reviewing each file and commenting #268

Merged
merged 1 commit into from
May 1, 2023

Conversation

harjotgill
Copy link
Contributor

@harjotgill harjotgill commented May 1, 2023

Summary by OpenAI

Release Notes:

  • New Feature: Adds a getShortSummary method to extract short summaries from strings and refactors code to use it.
  • Enhancement: Adds a shortSummary property to the Inputs class and includes it in the replace method calls.
  • Documentation: Adds instructions on how to parse changes and respond to them.
  • Refactor: Removes code that retrieves file contents and only packs the file diff and summary into inputs if they are not too long.

"Code changes abound,
Short summaries now astound,
Bugs and docs are found,
Celebrate all around!"

@github-actions
Copy link
Contributor

github-actions bot commented May 1, 2023

🤖 OpenAI

[SUMMARY]: The changes include adding a new method to extract short summaries from strings, defining start and end tags for short summaries, and refactoring the code to use this new method. Additionally, a new shortSummary property was added to the Inputs class and included in the replace method calls. The summarizeShort field was added to prompts.ts, and the renderSummarizeShort function was updated to use it. Finally, the code that retrieves file contents was removed from review-comment.ts, and only the file diff and summary are packed into the inputs if they are not too long.

File Summary
src/commenter.ts, src/review.ts Adds a new method getShortSummary to extract short summary from a string. Defines start and end tags for short summary. The code refactors to use getShortSummary function.
src/inputs.ts Adds a new shortSummary property to the Inputs class and includes it in the replace method calls.
src/prompts.ts Adds a new summarizeShort field and updates the renderSummarizeShort function to use it.
src/review-comment.ts Removes the code that retrieves file contents and only packs the file diff and summary into the inputs if they are not too long.

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.

Ignoring further reviews

  • Type @openai: ignore anywhere in the PR description to ignore further reviews from the bot.

Files ignored due to filter (1)

Ignored files

  • dist/index.js

In the recent run, only the files that changed from the base of the PR and between 716fca3580775c05b4a16a6b9d4778711adcbfbf and 7b517f12b8842f68f4ba3fe253555a8419ae9dff commits were reviewed.

Files not reviewed due to simple changes (4)

Skipped review in the recent run

  • src/commenter.ts
  • src/inputs.ts
  • src/prompts.ts
  • src/review.ts

@harjotgill harjotgill merged commit e26b178 into main May 1, 2023
@harjotgill harjotgill deleted the short_summary branch May 1, 2023 16:38
shoyuf pushed a commit to maybeLab/openai-mr-reviewer-gltlab that referenced this pull request Jun 25, 2023
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