department-of-veterans-affairs / vets-design-system-documentation

Repository for design.va.gov website
https://design.va.gov
37 stars 55 forks source link

Update Internal BigQuery Documentation #1157

Open pdavies88 opened 2 years ago

pdavies88 commented 2 years ago

Related Discovery Ticket

https://github.com/department-of-veterans-affairs/va.gov-team/issues/32882

Description

Using Google Cloud CLI and the bq tools that I provides we can upload our BigQuery data directly from a terminal. Therefore we can update the Updating Component Usage Report documentation here to reflect that approach.

Topics to add: (Related Discovery Ticket can inform this portion)

Acceptance Criteria

bkjohnson commented 2 years ago

What's the advantage of the bq cli tool over the bigquery npm package? I ask because the installation instructions for the gcloud cli in CI seem more complicated than adding a node dependency and running yarn install in CI.

pdavies88 commented 2 years ago

Personally I don't really like Google's docs on installation I thought they were confusing which is why I included the second link here: https://www.codingforentrepreneurs.com/blog/google-cloud-cli-and-sdk-setup which was much more straight forward. To me the biggest advantage is once the CLI tools are installed you can run gcloud auth login and you are verified to use the tools moving forward and we do not need to build anything new just run a few other commands and the upload is complete. If we go with the NPM package route we will have to build out a Node app to run the queries and authentication for us. I felt that the overhead there wasn't necessary when all of the steps could be completed with the CLI tools without having to build out any net new code.

bkjohnson commented 2 years ago

once the CLI tools are installed you can run gcloud auth login and you are verified to use the tools moving forward and we do not need to build anything new

This does seem nice.

If we end up going with the gcloud sdk, maybe this github action will be helpful for CI instead of trying to install it ourselves.