README
¶
Librarian
This repository contains command line tools for managing Google Cloud SDK
client libraries. The primary tool is librarian, which handles the full
library lifecycle: onboarding new libraries, generating code from API
specifications, bumping versions, and publishing releases.
Usage
Run librarian -help for a list of commands,
or see the command reference on pkg.go.dev.
To run without installing:
go run github.com/googleapis/librarian/cmd/librarian@latest -help
See the doc/ folder for additional documentation.
Contributing
This project supports the Google Cloud SDK ecosystem and is not intended for external use. For contribution guidelines, see CONTRIBUTING.md.
License
Apache 2.0 - See LICENSE for more information.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
librarian
command
Librarian manages Google Cloud client libraries.
|
Librarian manages Google Cloud client libraries. |
|
librarianops
command
Librarianops orchestrates librarian operations across multiple repositories.
|
Librarianops orchestrates librarian operations across multiple repositories. |
|
containers
module
|
|
|
internal
|
|
|
cache
Package cache manages the local cache directory for librarian operations.
|
Package cache manages the local cache directory for librarian operations. |
|
command
Package command provides helpers to execute external commands with logging.
|
Package command provides helpers to execute external commands with logging. |
|
config
Package config provides types and functions for reading and writing librarian.yaml configuration files.
|
Package config provides types and functions for reading and writing librarian.yaml configuration files. |
|
docuploader
Package docuploader provides functionality for packaging documentation for googleapis.dev and cloud.google.com.
|
Package docuploader provides functionality for packaging documentation for googleapis.dev and cloud.google.com. |
|
fetch
Package fetch provides utilities for fetching GitHub repository metadata and computing checksums.
|
Package fetch provides utilities for fetching GitHub repository metadata and computing checksums. |
|
filesystem
Package filesystem provides generic filesystem operations.
|
Package filesystem provides generic filesystem operations. |
|
git
Package git provides functions for determining changes in a git repository.
|
Package git provides functions for determining changes in a git repository. |
|
librarian
Package librarian provides functionality for onboarding, generating and releasing Google Cloud client libraries.
|
Package librarian provides functionality for onboarding, generating and releasing Google Cloud client libraries. |
|
librarian/dart
Package dart provides functionality for generating and releasing Dart client libraries.
|
Package dart provides functionality for generating and releasing Dart client libraries. |
|
librarian/golang
Package golang provides functionality for generating Go client libraries.
|
Package golang provides functionality for generating Go client libraries. |
|
librarian/java
Package java provides Java specific functionality for librarian.
|
Package java provides Java specific functionality for librarian. |
|
librarian/nodejs
Package nodejs provides Node.js-specific functionality for librarian.
|
Package nodejs provides Node.js-specific functionality for librarian. |
|
librarian/php
Package php provides PHP specific functionality for librarian.
|
Package php provides PHP specific functionality for librarian. |
|
librarian/python
Package python provides Python specific functionality for librarian.
|
Package python provides Python specific functionality for librarian. |
|
librarian/ruby
Package ruby provides Ruby specific functionality for librarian.
|
Package ruby provides Ruby specific functionality for librarian. |
|
librarian/rust
Package rust provides Rust specific functionality for librarian.
|
Package rust provides Rust specific functionality for librarian. |
|
librarian/swift
Package swift provides functionality for generating Swift client libraries.
|
Package swift provides functionality for generating Swift client libraries. |
|
librarianops
Package librarianops provides orchestration for running librarian across multiple repositories.
|
Package librarianops provides orchestration for running librarian across multiple repositories. |
|
license
Package license provides functions for generating license header text.
|
Package license provides functions for generating license header text. |
|
postprocessing
Package postprocessing provides tools for the YAML-based postprocessing workflow.
|
Package postprocessing provides tools for the YAML-based postprocessing workflow. |
|
repometadata
Package repometadata represents the data in .repo-metadata.json files, and the ability to create those files from other Librarian configuration.
|
Package repometadata represents the data in .repo-metadata.json files, and the ability to create those files from other Librarian configuration. |
|
sample
Package sample provides functionality for generating sample values of the types contained in the internal package for testing purposes.
|
Package sample provides functionality for generating sample values of the types contained in the internal package for testing purposes. |
|
semver
Package semver provides functionality for parsing, comparing, and manipulating semantic version strings according to the SemVer 1.0.0 and 2.0.0 spec.
|
Package semver provides functionality for parsing, comparing, and manipulating semantic version strings according to the SemVer 1.0.0 and 2.0.0 spec. |
|
serviceconfig
Package serviceconfig reads and parses API service config files.
|
Package serviceconfig reads and parses API service config files. |
|
sidekick/api
Package api defines the data model representing a parsed API surface.
|
Package api defines the data model representing a parsed API surface. |
|
sidekick/api/apitest
Package apitest provides helper functions for testing the api package.
|
Package apitest provides helper functions for testing the api package. |
|
sidekick/codec_sample
Package codec_sample provides an example implementation of a code generator.
|
Package codec_sample provides an example implementation of a code generator. |
|
sidekick/dart
Package dart implements a native Dart code generator.
|
Package dart implements a native Dart code generator. |
|
sidekick/language
Package language provides common utilities for language-specific code generation
|
Package language provides common utilities for language-specific code generation |
|
sidekick/parser
Package parser reads specifications and converts them into the `genclient.API` model.
|
Package parser reads specifications and converts them into the `genclient.API` model. |
|
sidekick/parser/discovery
Package discovery parses Google Discovery Documents into the sidekick abstract API model (`api.API`).
|
Package discovery parses Google Discovery Documents into the sidekick abstract API model (`api.API`). |
|
sidekick/parser/httprule
Package httprule provides a parser for the path templates found in [google.api.http] annotations.
|
Package httprule provides a parser for the path templates found in [google.api.http] annotations. |
|
sidekick/parser/svcconfig
Package svcconfig contains helper functions to parse service config files.
|
Package svcconfig contains helper functions to parse service config files. |
|
sidekick/protobuf
Package protobuf provides utilities for handling protobuf files.
|
Package protobuf provides utilities for handling protobuf files. |
|
sidekick/rust
Package rust implements a native Rust code generator.
|
Package rust implements a native Rust code generator. |
|
sidekick/rust_prost
Package rust_prost implements a Rust code generator using the prost toolchain.
|
Package rust_prost implements a Rust code generator using the prost toolchain. |
|
sidekick/swift
Package swift provides a code generator for Swift.
|
Package swift provides a code generator for Swift. |
|
snippetmetadata
Package snippetmetadata provides cross-language functionality for working with metadata files associated with generated sample code.
|
Package snippetmetadata provides cross-language functionality for working with metadata files associated with generated sample code. |
|
sources
Package sources provides types for resolved source repository paths and path resolution utilities.
|
Package sources provides types for resolved source repository paths and path resolution utilities. |
|
testhelper
Package testhelper provides helper functions for tests.
|
Package testhelper provides helper functions for tests. |
|
tool/gem
Package gem provides utility functions for installing Ruby gems via gem.
|
Package gem provides utility functions for installing Ruby gems via gem. |
|
tool/pip
Package pip provides utility functions for installing Python packages via pip.
|
Package pip provides utility functions for installing Python packages via pip. |
|
tool/pnpm
Package pnpm provides utilities to install pnpm packages.
|
Package pnpm provides utilities to install pnpm packages. |
|
tool/protoc
Package protoc provides utilities for installing the protoc tool.
|
Package protoc provides utilities for installing the protoc tool. |
|
yaml
Package yaml provides generic YAML read and write operations.
|
Package yaml provides generic YAML read and write operations. |
|
tool
|
|
|
cmd/builddockerimages
command
Command build-docker-images builds and tag multiple language-specific Docker images based on a librarian version.
|
Command build-docker-images builds and tag multiple language-specific Docker images based on a librarian version. |
|
cmd/coverage
command
coverage runs Go tests with coverage and checks that the total coverage percentage meets a per-component target.
|
coverage runs Go tests with coverage and checks that the total coverage percentage meets a per-component target. |
|
cmd/importconfigs
command
import configs is a tool to import configs from googleapis into api.go intended to be a temp tool during migration
|
import configs is a tool to import configs from googleapis into api.go intended to be a temp tool during migration |
|
cmd/importconfigs/bazel
Package bazel parses BUILD.bazel files to extract GAPIC configuration.
|
Package bazel parses BUILD.bazel files to extract GAPIC configuration. |
|
cmd/migrate
command
Command migrate is a tool for migrating .sidekick.toml or .librarian configuration to librarian.yaml.
|
Command migrate is a tool for migrating .sidekick.toml or .librarian configuration to librarian.yaml. |
Click to show internal directories.
Click to hide internal directories.