Skip to content

gh2gcs: add initial documentation #1338

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
merged 1 commit into from
Jun 7, 2020
Merged

gh2gcs: add initial documentation #1338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions cmd/gh2gcs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# GitHub Releases to Google Cloud Storage

This directory contains a tool called `gh2gcs` that downloads a release published in GitHub to a Google Cloud Storage Bucket.

## Requirements

This tool directly depends on `gcloud` and `gsutil` to be installed on the system.

Google Cloud has [documentation on installing and configuring the Google Cloud SDK CLI tools](https://cloud.google.com/sdk/docs/quickstarts).

## Install

The simplest way to install the `gh2gcs` CLI is via `go get`:

```
$ go get k8s.io/release/cmd/gh2gcs
```

This will install `gh2gcs` to `$(go env GOPATH)/bin/gh2gcs`.

## Usage

To use this tool to copy a release to a Google Cloud Storage, run:

```bash
$ gh2gcs \
--org kubernetes --repo kubernetes --bucket my-test-bucket \
--release-dir release --tags v1.18.0

INFO Validating gh2gcs options...
INFO Downloading assets for the following kubernetes/kubernetes release tags: v1.18.0
INFO Download assets for kubernetes/[email protected]
INFO Writing assets to /tmp/test/kubernetes/kubernetes/v1.18.0
...

```