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

fix(gae): add new region tags with "gae_storage_" prefix #5037

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

OremGLG
Copy link
Contributor

@OremGLG OremGLG commented Jan 9, 2025

Description

Migration step 1

Migrate all region tags adding the "gae_storage_" prefix
Fixes b/387483288

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

Checklist

  • I have followed Contributing Guidelines from CONTRIBUTING.MD
  • Tests pass: go test -v ./.. (see Testing)
  • Code formatted: gofmt (see Formatting)
  • Vetting pass: go vet (see Formatting)
  • 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)
  • 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

Copy link

@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 team,

I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly understand the changes:

This pull request, submitted by OremGLG, aims to add new region tags with the prefix "gae_storage_" as a migration step. This addresses issue b/387483288.

The changes are focused on the docs/appengine/storage/app.go file. Specifically, the PR modifies comments and adds the gae_storage_ prefix to several comment blocks, such as those surrounding import statements, get_default_bucket, write, read, copy, and list_bucket functions. The changes are primarily cosmetic, updating existing comment blocks to include the new prefix.

Here's a breakdown of the changes:

  • Added gae_storage_ prefix to comments: The gae_storage_ prefix has been added to numerous comment blocks throughout the app.go file. This is consistent across various functions, including file creation, reading, copying, and listing buckets.

  • No functional changes: The core functionality of the application remains unchanged. This PR focuses solely on updating comments.

I'll provide a more detailed review soon, but this summary should give you a good overview of the changes.


And now, a little haiku to lighten the mood:

Prefix added now,
Code comments clearer, bright, bold,
Review flows smoothly.

@product-auto-label product-auto-label bot added the samples Issues that are directly related to samples. label Jan 9, 2025
Copy link

@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 adds new region tags with the "gae_storage_" prefix to the App Engine storage sample. This is a good practice for organizing and managing code snippets within documentation. The changes are well-structured and easy to understand. The added prefixes clearly distinguish the App Engine specific snippets from the general Cloud Storage snippets. The checklist is mostly irrelevant for this change and should be simplified.

Comment on lines +72 to 73
//[START gae_storage_get_default_bucket]
//[START get_default_bucket]

Choose a reason for hiding this comment

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

low

Consider adding a short comment explaining the purpose of dev_appserver.py --default_gcs_bucket_name GCS_BUCKET_NAME and how it helps when running the application locally.

Suggested change
//[START gae_storage_get_default_bucket]
//[START get_default_bucket]
//[START gae_storage_get_default_bucket]
//[START get_default_bucket]

@OremGLG OremGLG marked this pull request as ready for review January 9, 2025 19:51
@OremGLG OremGLG requested review from a team as code owners January 9, 2025 19:51
Copy link

snippet-bot bot commented Jan 9, 2025

Here is the summary of changes.

You are about to add 6 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants