Skip to content

Conversation

@zhan7236
Copy link

The usage documentation in beam-linkage-check.sh showed origin/master as an example, which incorrectly suggested that users must have a remote called "origin". The script actually accepts any valid git reference.

Changes:

  • Use generic <baseline ref> placeholder instead of origin/master
  • Add examples of valid git references:
    • Remote branches: origin/master, upstream/main
    • Local branches: master, my-feature-branch
    • Commit SHAs: abc123def
    • Tags: v2.50.0

Fixes #20650


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

The usage documentation previously showed 'origin/master' as an example,
which incorrectly suggested that users must have a remote called 'origin'.
The script actually accepts any valid git reference.

This change clarifies the documentation by:
- Using generic '<baseline ref>' placeholder instead of 'origin/master'
- Adding examples of valid git references (remote branches, local branches,
  commit SHAs, and tags)

Fixes apache#20650
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @zhan7236, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request improves the documentation for the beam-linkage-check.sh script by making its usage instructions more generic and providing clear examples of the various git references it supports. This enhancement ensures that users can more easily understand and utilize the script with different types of git references, removing ambiguity from the previous example.

Highlights

  • Documentation Clarity: The usage example in beam-linkage-check.sh has been updated from a specific origin/master to a generic <baseline ref> placeholder, clarifying that the script accepts any valid git reference, not just a remote named 'origin'.
  • Expanded Git Reference Examples: Comprehensive examples of valid git references have been added to the script's documentation, including remote branches (e.g., origin/master), local branches (e.g., master), commit SHAs (e.g., abc123def), and tags (e.g., v2.50.0), to improve user understanding and flexibility.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Contributor

Assigning reviewers:

R: @chamikaramj for label java.
R: @liferoad for label build.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Linkage check script assumes you have a remote called origin

1 participant