gapic

Support

Need	Where
A build/release/automation bug in this repo	Open an issue
Questions about installing/using the published plugins	Discussions
Bugs in the generated output or the generators themselves	Upstream: gapic-generator-go · gapic-generator-typescript · gapic-generator-python

This project only repackages and redistributes upstream code — it does not modify the generators. Issues with what a generator produces belong upstream; issues with how it’s built or shipped belong here.

Latest release

Each plugin tracks its own upstream version on an independent tag stream (go-v*, ts-v*, py-v*). The badges at the top always show the current released version; browse all artifacts on the Releases page.

Plugin	Built from	Tag stream	Binary
Go	`gapic-go` → `cmd/protoc-gen-go_gapic`	`go-v*`	`protoc-gen-go_gapic`
Node/TS	`gapic-node` → `core/generator/gapic-generator-typescript`	`ts-v*`	`protoc-gen-typescript_gapic`
Python	`gapic-python` → `packages/gapic-generator`	`py-v*`	`protoc-gen-python_gapic`

Install

Homebrew (macOS + Linux, amd64/arm64):

brew install the-protobuf-project/tap/protoc-gen-go-gapic
brew install the-protobuf-project/tap/protoc-gen-typescript-gapic
brew install the-protobuf-project/tap/protoc-gen-python-gapic

Windows / no-brew — straight from the GitHub Release:


#     Optional (if a scoop-bucket is configured):
#     scoop install the-protobuf-project/protoc-gen-go_gapic

# Python: works everywhere, including Windows
pip install <wheel-from-release>

# Node: extract the released tarball, then invoke with Node (>=18)
node path\to\build\typescript\src\protoc-plugin.js

Platform support

	Linux amd64	Linux arm64	macOS arm64 (silicon)	Windows
Go	formula / binary	yes	yes	`.zip` (+ optional Scoop)
Node/TS	formula / tarball	yes	yes	tarball (`node …`)
Python	formula / `pip`	yes	yes	`pip install`

Go — pure-Go static binary, CGO_ENABLED=0, cross-compiled to all six targets.
Node/TS — pure JavaScript; one artifact runs on every arch/OS (needs Node ≥ 18).
Python — pip resolves the correct per-arch native deps (grpcio, libcst, protobuf); macOS-arm64 and manylinux-aarch64 wheels exist for all of them.
Homebrew formulae (not casks) are used so brew works on both macOS and Linux.

Architecture

Pipeline

Release sequence

Why this repo exists

Google ships three excellent GAPIC protoc plugins — but each lives in a different place, in a different language, with a different release cadence, and none is distributed as a ready-to-run cross-platform binary you can just brew install:

the Go generator publishes only source + a container image,
the TypeScript generator is buried inside the giant google-cloud-node monorepo,
the Python generator is buried inside the giant google-cloud-python monorepo.

This repository is a thin distribution layer:

Aggregates all three as pristine git submodules — no upstream code is forked or edited.
Mirrors each generator’s upstream version exactly (read from release-please-manifest.json / package.json / setup.py).
Auto-builds and releases prebuilt artifacts for Linux (amd64/arm64), macOS (Apple Silicon/Intel), and Windows whenever upstream changes — once a week or on demand.
Provides one consistent install story (Homebrew formula, GitHub Release, Scoop).

The goal: all of the distribution, none of the maintenance. If upstream releases, you get a new binary automatically; there is no generator code here to own.

One-time setup

bash scripts/setup-repo.sh — converts the existing clones into submodules without re-downloading the multi-GB monorepos, then commits the aggregator. Add CREATE_REMOTE=1 to also create the GitHub repos.
Create the-protobuf-project/homebrew-tap (public) if it doesn’t exist.
Set repository secrets on the-protobuf-project/gapic:
- RELEASE_PAT — PAT (repo scope). Lets sync.yml push tags so the release workflows actually fire (the default GITHUB_TOKEN cannot trigger downstream workflows).
- HOMEBREW_TAP_GITHUB_TOKEN — PAT (repo scope) on the tap repo.
- SCOOP_BUCKET_GITHUB_TOKEN (optional) — enables the Windows Scoop manifest for Go.
Run the first release: Actions → Sync upstream & release → Run workflow.

Manual sync

The GitHub “Sync fork” button only applies to true forks; here the upstreams are submodules, so use the workflow:

gh workflow run sync.yml -R the-protobuf-project/gapic
# or
gh api repos/the-protobuf-project/gapic/dispatches -f event_type=sync

Copyright

Maintained under the the-protobuf-project org.

The aggregation/automation tooling in this repository (workflows, scripts, packaging config) is licensed under Apache-2.0.
The GAPIC generators themselves are © Google LLC, redistributed unmodified from googleapis. All trademarks belong to their owners.

This is an independent redistribution and is not affiliated with or endorsed by Google.

License

Licensed under the Apache License, Version 2.0 — the same license as all three upstream generators (gapic-generator-go, gapic-generator-typescript, gapic-generator-python are each Apache-2.0), so redistribution here is fully license-compatible. See LICENSE, or https://www.apache.org/licenses/LICENSE-2.0.