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

doc: CHANGELOG entry for #8022 #12507

Merged
merged 5 commits into from
Sep 1, 2023
Merged

Conversation

dbolduc
Copy link
Member

@dbolduc dbolduc commented Aug 31, 2023

This change is Reviewable

@dbolduc dbolduc temporarily deployed to internal August 31, 2023 05:16 — with GitHub Actions Inactive
@codecov
Copy link

codecov bot commented Aug 31, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.01% ⚠️

Comparison is base (178d658) 93.63% compared to head (cff7469) 93.62%.
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12507      +/-   ##
==========================================
- Coverage   93.63%   93.62%   -0.01%     
==========================================
  Files        2043     2043              
  Lines      180935   180935              
==========================================
- Hits       169410   169408       -2     
- Misses      11525    11527       +2     

see 4 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dbolduc dbolduc temporarily deployed to internal August 31, 2023 06:10 — with GitHub Actions Inactive
@dbolduc dbolduc marked this pull request as ready for review August 31, 2023 06:10
@dbolduc dbolduc requested a review from a team as a code owner August 31, 2023 06:10
coryan
coryan previously requested changes Aug 31, 2023
CHANGELOG.md Outdated
@@ -140,6 +140,48 @@ The library has been expanded to include the v2 service.
consider this a breaking change, as Bazel 5.x has been in maintenance mode for
more than 6 months.

**CMake Proto Libraries**: We no longer compile certain protos, unless the
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe "we only compile the service-specific protos if the corresponding client library is enabled via `-DGOOGLE_CLOUD_CPP_ENABLE" ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

CHANGELOG.md Outdated
**CMake Proto Libraries**: We no longer compile certain protos, unless the
corresponding client library is enabled, via `-DGOOGLE_CLOUD_CPP_ENABLE=...`.

This change reduces build times with `cmake` for customers who build with
Copy link
Contributor

Choose a reason for hiding this comment

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

I would use CMake (without code style) in this context. I think we should use cmake (with code style) when referring to the command itself, not the system.

Copy link
Contributor

Choose a reason for hiding this comment

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

And remove the "with CMake" duplication. So, "This change reduces build times for customers who use CMake but who are not using ...."

Copy link
Member Author

Choose a reason for hiding this comment

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

Done and done.

CHANGELOG.md Outdated
this change eclipse the number of customers who are affected negatively by it.
Hence, we think this change is necessary.

We offered many of these proto libraries before we could write and maintain the
Copy link
Contributor

Choose a reason for hiding this comment

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

This information probably belongs in the comments on #8022, but maybe not here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed

CHANGELOG.md Outdated
Note that `google_cloud_cpp_storage_protos` are associated with the
`experimental-storage-grpc` feature, not the `storage` feature.

We do not make changes that can break our customers lightly. We considered it
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe move the paragraph earlier, maybe before "The impacted libraries". And maybe consider something like:

Compiling these protos when not strictly needed was a bug for some customers, and confusing to other customers.
Any change in behavior, including fixing bugs, can be considered "breaking". By policy we don't consider bug fixes to be breaking changes. And we applied that policy in this case.

Skip the comment about the number of customers affected.

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe move the paragraph earlier, maybe before "The impacted libraries".

Done.

maybe consider something like:

I used your second paragraph, but I preferred my first paragraph.

Skip the comment about the number of customers affected.

Done.

@dbolduc dbolduc temporarily deployed to internal August 31, 2023 19:07 — with GitHub Actions Inactive
CHANGELOG.md Outdated
compiling the corresponding client library, you will need to update your build
scripts.

For example, if you depend on `google_cloud_cpp_speech_protos`, (e.g. if you
Copy link
Contributor

Choose a reason for hiding this comment

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

s/, (e.g. if/ (e.g., if/

Copy link
Member Author

Choose a reason for hiding this comment

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

took two commits, but done.

@dbolduc dbolduc temporarily deployed to internal August 31, 2023 20:34 — with GitHub Actions Inactive
@dbolduc dbolduc temporarily deployed to internal August 31, 2023 20:35 — with GitHub Actions Inactive
@dbolduc dbolduc merged commit 5727177 into googleapis:main Sep 1, 2023
@dbolduc dbolduc deleted the fix-8022-changelog branch September 1, 2023 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants