Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(job): delete old region tags from LocationSearchSample.java #9916

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

OremGLG
Copy link
Contributor

@OremGLG OremGLG commented Dec 24, 2024

Description

Fixes
b/347826159
basic_location_search -> job_basic_location_search

b/347826166
keyword_location_search -> job_keyword_location_search

b/347826161
city_location_search -> job_city_location_search

b/347826174
multi_locations_search -> job_multi_locations_search

b/384049653
broadening_location_search -> job_broadening_location_search

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

Checklist

  • I have followed Sample Format Guide
  • pom.xml parent set to latest shared-configuration
  • Appropriate changes to README are included in PR
  • These samples need a new API enabled in testing projects to pass (let us know which ones)
  • These samples need a new/updated env vars in testing projects set to pass (let us know which ones)
  • Tests pass: mvn clean verify required
  • Lint passes: mvn -P lint checkstyle:check required
  • Static Analysis: mvn -P lint clean compile pmd:cpd-check spotbugs:check advisory only
  • This sample adds a new sample directory, and I updated the CODEOWNERS file with the codeowners for this sample
  • This sample adds a new Product API, and I updated the Blunderbuss issue/PR auto-assigner with the codeowners for this sample
  • Please merge this PR for me once it is approved

@OremGLG OremGLG requested review from yoshi-approver and a team as code owners December 24, 2024 21:50
Copy link

snippet-bot bot commented Dec 24, 2024

Here is the summary of possible violations 😱

There are 2 possible violations for removing region tag in use.

The end of the violation section. All the stuff below is FYI purposes only.


Here is the summary of changes.

You are about to delete 5 region tags.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label bot added samples Issues that are directly related to samples. api: jobs Issues related to the Cloud Talent Solution Job Search API. labels Dec 24, 2024
Copy link
Contributor

@code-review-assist code-review-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi OremGLG, fellow code explorers!

I'm currently reviewing your pull request and will have a full review ready in a few minutes. In the meantime, here's a quick summary to help you and other reviewers get up to speed.

This pull request, titled "chore(job): delete old region tags from LocationSearchSample.java", aims to clean up the LocationSearchSample.java file by removing outdated region tags. The original tags were likely related to older sample organization, and this update aligns the code with current best practices.

Here's a breakdown of the changes:

  • File Affected: jobs/v3/src/main/java/com/google/samples/LocationSearchSample.java
  • Changes: The pull request removes several outdated region tags from the LocationSearchSample.java file. Specifically, the following tags have been removed:
    • // [START basic_location_search]
    • // [END basic_location_search]
    • // [START keyword_location_search]
    • // [END keyword_location_search]
    • // [START city_location_search]
    • // [END city_location_search]
    • // [START multi_locations_search]
    • // [END multi_locations_search]
    • // [START broadening_location_search]
    • // [END broadening_location_search]
      These were replaced with the newer job_ prefixed tags.
  • Intent: To improve code clarity and maintainability by removing redundant and outdated region tags. This simplifies the code and makes it easier to understand and maintain.

I've checked the diff and the changes seem straightforward and well-executed. I'll provide a more detailed review shortly.


And now, a little haiku to lighten the mood:

Old tags now removed,
Code shines, clean and bright anew,
Review's swift and smooth.

Copy link
Contributor

@code-review-assist code-review-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This pull request removes outdated region tags from the LocationSearchSample.java file. This is a good cleanup that improves maintainability. The commit message clearly explains the changes and links to the relevant bug fixes. The checklist is thorough and well-organized. One minor point: the checklist item regarding README changes is unchecked. If the README needs updating to reflect these changes, please do so. Otherwise, remove the item from the checklist.

I didn't find a specific style guide linked in the PR description or the repository, so I'm defaulting to general Java best practices and the Google Java Style Guide where applicable. In this review, I've focused on ensuring comments are clear, concise, and up-to-date, which aligns with general Java best practices.

@OremGLG OremGLG added the snippet-bot:force-run Force snippet-bot runs its logic label Dec 24, 2024
@snippet-bot snippet-bot bot removed the snippet-bot:force-run Force snippet-bot runs its logic label Dec 24, 2024
@OremGLG OremGLG added the snippet-bot:force-run Force snippet-bot runs its logic label Dec 24, 2024
@snippet-bot snippet-bot bot removed the snippet-bot:force-run Force snippet-bot runs its logic label Dec 24, 2024
@iennae
Copy link
Contributor

iennae commented Dec 29, 2024

verify that they aren't in use here:

jobs/v3/src/main/java/com/google/samples/LocationSearchSample.java:52, tag basic_location_search(usage: page 1).
jobs/v3/src/main/java/com/google/samples/LocationSearchSample.java:195, tag broadening_location_search(usage: page 1).

@OremGLG
Copy link
Contributor Author

OremGLG commented Dec 30, 2024

verify that they aren't in use here:

jobs/v3/src/main/java/com/google/samples/LocationSearchSample.java:52, tag basic_location_search(usage: page 1). jobs/v3/src/main/java/com/google/samples/LocationSearchSample.java:195, tag broadening_location_search(usage: page 1).

Both regions already have the "job_" preffix in the documentation:
https://critique.corp.google.com/cl/648538021/depot/google3/googledata/devsite/site-cloud/en/talent-solution/job-search/v3/docs/search-location.md

Isn't that the file we have to edit for the published page?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: jobs Issues related to the Cloud Talent Solution Job Search API. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants