Skip to content

Restructure first-time setup steps in README.md #49

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.

Sign up for GitHub

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

Merged
xianyuanjia merged 2 commits into from
May 8, 2026
Merged

Restructure first-time setup steps in README.md #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a116ce
Restructure first-time setup steps in README.md
xianyuanjia May 8, 2026
1a01147
Gemini-suggested fix
xianyuanjia May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,22 @@ results in an organized way on a dedicated web UI (Resultstore/BTX). The result
URL can then be shared to anyone who is given access (including both Google and
non-Google accounts), allowing for easy tracking and debugging.

### Before you start

Test results are uploaded to a dedicated GCP project for your organization.

Confirm/request access to your organization's GCP project with your Google contact. The
Googler will give you the right Project ID to use for setting up.

### First-time setup

To start using the Results Uploader, you need to be able to access the shared
Google Cloud Storage bucket:
To start using the Results Uploader, you need to set up local credentials for GCP:

1. Confirm/request access to the shared GCP project with your Google contact.
The Googler will give you a project name to use.
2. Install the gcloud CLI from https://docs.cloud.google.com/sdk/docs/install-sdk#latest-version
1. Install the gcloud CLI from https://docs.cloud.google.com/sdk/docs/install-sdk#latest-version
* Skip the "Before you begin" steps.
* If installation fails with the above method, try the alternative linked
[here](https://cloud.google.com/sdk/docs/downloads-versioned-archives#installation_instructions).
3. Download and execute [this script](src/results_uploader/gcloud_setup.py) to
2. Download and execute [this script](src/results_uploader/gcloud_setup.py) to
log into the GCP project, and set up local credentials.

### How to upload results
Expand Down
Loading