Skip to content

docs(iam): added comments on private_key_data#8204

Merged
coryan merged 5 commits into
mainfrom
patch-iam-docs
Feb 2, 2022
Merged

docs(iam): added comments on private_key_data#8204
coryan merged 5 commits into
mainfrom
patch-iam-docs

Conversation

@Sita04
Copy link
Copy Markdown
Contributor

@Sita04 Sita04 commented Feb 1, 2022

This change is Reviewable

@Sita04 Sita04 requested review from a team and coryan February 1, 2022 13:07
@product-auto-label product-auto-label Bot added the samples Issues that are directly related to samples. label Feb 1, 2022
@google-cloud-cpp-bot
Copy link
Copy Markdown
Contributor

Google Cloud Build Logs
For commit: 2bd92deb2f3806c22a95fa8ce1bd20dbd14dd607

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

Comment thread google/cloud/iam/samples/iam_samples.cc Outdated
if (!response) throw std::runtime_error(response.status().message());
// The private_key_data field in the response contains the
// service account key in JSON format.
// TODO(Developer): Save the key to a secure location.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We do not leave TODO(Developer) marks in our examples. Also note that these examples are executable as-is, the parameters are received from the command-line, so the developer may not see this comment. I think instead we should do something like:

  std::cout << "ServiceAccountKey successfully created: "
                  << response->DebugString() << "\n";
                  <<  "Please save the key in a secure location, as they cannot be downloaded later\n";

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the insight. Modified the comment.

@coryan coryan changed the title docs(iam-samples): added comments on private_key_data docs(iam): added comments on private_key_data Feb 1, 2022
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 1, 2022

Codecov Report

Merging #8204 (4c6ab44) into main (6ff74ae) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #8204      +/-   ##
==========================================
- Coverage   94.63%   94.62%   -0.01%     
==========================================
  Files        1323     1323              
  Lines      118583   118583              
==========================================
- Hits       112218   112213       -5     
- Misses       6365     6370       +5     
Impacted Files Coverage Δ
google/cloud/storage/internal/curl_handle.h 80.00% <0.00%> (-2.86%) ⬇️
...cloud/pubsub/internal/subscription_session_test.cc 97.75% <0.00%> (-1.25%) ⬇️
...le/cloud/storage/internal/curl_download_request.cc 89.75% <0.00%> (-0.36%) ⬇️
.../cloud/storage/benchmarks/throughput_experiment.cc 74.87% <0.00%> (+0.50%) ⬆️
...le/cloud/internal/default_completion_queue_impl.cc 97.72% <0.00%> (+0.56%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ff74ae...4c6ab44. Read the comment docs.

@coryan
Copy link
Copy Markdown
Contributor

coryan commented Feb 1, 2022

FYI, the robots do not like the extra space at the end of one of your comments. Public versions of the logs are available from #8204 (comment)

@google-cloud-cpp-bot
Copy link
Copy Markdown
Contributor

Google Cloud Build Logs
For commit: d2471b6e1bc8e72816f32f41aed40c9e1b99b5b7

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

@google-cloud-cpp-bot
Copy link
Copy Markdown
Contributor

Google Cloud Build Logs
For commit: 007b2c5d0bc0195b501ef8777674c0d0a116591c

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

@google-cloud-cpp-bot
Copy link
Copy Markdown
Contributor

Google Cloud Build Logs
For commit: ac834c3642bb4ac7504f44a75592991cf137f27c

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

@coryan
Copy link
Copy Markdown
Contributor

coryan commented Feb 1, 2022

These instructions may help you speed up the edit -> test -> edit cycle:

https://github.com/googleapis/google-cloud-cpp/blob/main/doc/contributor/howto-guide-forks-and-pull-requests.md#reproducing-ci-build-failures

https://github.com/googleapis/google-cloud-cpp/blob/main/doc/contributor/howto-guide-running-ci-builds-locally.md

Please refrain from starting more builds until at least checkers passes locally on your workstation. We have limited capacity for Windows and macOS builds.

@google-cloud-cpp-bot
Copy link
Copy Markdown
Contributor

Google Cloud Build Logs
For commit: 4c6ab44dee5cc16ec1a9dd1ddfd5748789bfa8ee

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

@product-auto-label product-auto-label Bot added the api: iam Issues related to the Identity and Access Management API. label Feb 2, 2022
@coryan coryan enabled auto-merge (squash) February 2, 2022 12:53
@coryan coryan disabled auto-merge February 2, 2022 12:53
@coryan
Copy link
Copy Markdown
Contributor

coryan commented Feb 2, 2022

Thanks for the PR! I will fix the build problem and merge this later today. We are in the middle of a release so please don't merge quite yet.

@coryan coryan added do not merge Indicates a pull request not ready for merge, due to either quality or timing. and removed do not merge Indicates a pull request not ready for merge, due to either quality or timing. labels Feb 2, 2022
@coryan coryan enabled auto-merge (squash) February 2, 2022 14:49
@coryan coryan merged commit f06a920 into main Feb 2, 2022
@coryan coryan deleted the patch-iam-docs branch February 2, 2022 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: iam Issues related to the Identity and Access Management API. samples Issues that are directly related to samples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants