githubissues

command
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 27, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

README

Github issues

Overview

This command queries all open Github issues in an organization or repository, and loads that data to a BigQuery table.

NOTE: If the JSON file is bigger than 100MB, Bigquery fails. To fix that issue, you can split the file into smaller parts and upload them manually before running the program.

Flags

See the list of available flags:

Name Required Description
--githubOrgName Yes The string value with the Github organization name to retrieve issues from.
--githubRepoName No The string value with the Github repository name to retrieve issues from.
--githubToken Yes The string value with the Github OAuth token.
--githubBaseURL No The string value with the custom Github API base URL.
--issuesFilename No The string value with the name of the generated file with list of issues. It defaults to issues.json.
--bqCredentials Yes The string value with the path to BigQuery credentials JSON file.
--bqProjectID Yes The string value with the name of the BigQuery project.
--bqDatasetName Yes The string value with the name of the BigQuery dataset.
--bqTableName Yes The string value with the name of the BigQuery table.

Creating empty table

This program assumes that the table already exists. In order to create new table, do the following:

  1. Go to BigQuery console.
  2. Create new table in a dataset.
  3. Edit the schema as text:
  • For an organization, copy the schema from table_org_schema.json.
  • For a singular repo, copy the schema from table_repo_schema.json.
  1. In the partitioning dropdown list, select updated_at field.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL