discovery-artifact-manager

module
v0.0.0-...-d53c0b3 Latest Latest
Warning

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

 Go to latest Published: Dec 20, 2024 License: Apache-2.0

README

Introduction

The Discovery Artifact Manager is intended to facilitate testing, publishing, and synchronization of generators and artifacts for client libraries and generated code samples of Google APIs defined by the API Discovery Service.

Discovery doc cache

To aid hermetic testing of client libraries and samples (avoiding synchronization issues), the discoveries directory hosts a local cache of Discovery docs from the API Discovery Service.

This cache is updated by an internal mechanism and cannot be run locally at this time. Discovery files are expected (but not guaranteed) to be updated O(day) from availability in the API Discovery Service. These documents are only updated if they materially change and are normalized (sorted keys) to make reviewing diffs possible.

Discovery based clients

Discovery-based client library code is not available in this repository.

Deprecations

  • [DEPRECATED] the copy of the Google API client library generator code in the google-api-client-generator folder
  • [DEPRECATED] the copy of the code samples generator toolkit in the toolkit folder

Directories

Path Synopsis
src
common/clone
Package clone implements a generic Clone() operation applicable to all types.
 Package clone implements a generic Clone() operation applicable to all types.
common/environment
Package environment returns information about the environment in which this binary executes.
 Package environment returns information about the environment in which this binary executes.
common/errorlist
Package errorlist maintains a list of errors that clients can populate and later retrieve, in order to present multiple errors to the user at once (as opposed to causing piecemeal incremental failures as the user fixes one error and re-runs).
 Package errorlist maintains a list of errors that clients can populate and later retrieve, in order to present multiple errors to the user at once (as opposed to causing piecemeal incremental failures as the user fixes one error and re-runs).
common/gcs
Package gcs allows users to run the gsutil command to upload data to Google Cloud storage.
 Package gcs allows users to run the gsutil command to upload data to Google Cloud storage.
common/parsehtml
Package parsehtml provides utilities for parsing HTML-format library documentation, which is referenced for type information by the Python "compile" check.
 Package parsehtml provides utilities for parsing HTML-format library documentation, which is referenced for type information by the Python "compile" check.
main/common
main/nodejs
main/ruby
main/update
Package update provides the top-level `Update` function to refresh and regenerate artifacts in discovery-artifact-manager
 Package update provides the top-level `Update` function to refresh and regenerate artifacts in discovery-artifact-manager
main/updatedisco
Package main provides a standalone executable `updatedisco` to update the local Discovery doc cache from the live Discovery service in a top-level directory 'discoveries', which must exist.
 Package main provides a standalone executable `updatedisco` to update the local Discovery doc cache from the live Discovery service in a top-level directory 'discoveries', which must exist.
proto
snippetgen/common/clientlib
Package clientlib provides utility functions to help with downloading client libraries.
 Package clientlib provides utility functions to help with downloading client libraries.
snippetgen/common/fragment
Package fragment defines the format of the fragment files that will eventually be displayed on documentation pages.
 Package fragment defines the format of the fragment files that will eventually be displayed on documentation pages.
snippetgen/common/metadata
Package metadata contains utility functions as well as run-time constants for creating the fragment files.
 Package metadata contains utility functions as well as run-time constants for creating the fragment files.
snippetgen/compilecheck
compilecheck sets up tests to check the validity of generated code samples.
 compilecheck sets up tests to check the validity of generated code samples.
snippetgen/compilecheck/internal/checker
snippetgen/compilecheck/internal/csharp
Package csharp implements compile checking for C#.code samples.
 Package csharp implements compile checking for C#.code samples.
snippetgen/compilecheck/internal/filesys
Package filesys contains abstractions and mocks of the file system, useful for testing.
 Package filesys contains abstractions and mocks of the file system, useful for testing.
snippetgen/compilecheck/internal/golang
Package golang implements compile checking for Go code samples.
 Package golang implements compile checking for Go code samples.
snippetgen/compilecheck/internal/java
Package java implements compilecheck for Java.
 Package java implements compilecheck for Java.
snippetgen/compilecheck/internal/js
Package js implements compilecheck for JS.
 Package js implements compilecheck for JS.
snippetgen/compilecheck/internal/langutil
Package langutil provides language-independent types useful for processing code snippets and client libraries.
 Package langutil provides language-independent types useful for processing code snippets and client libraries.
snippetgen/compilecheck/internal/nodejs
Package nodejs implements compilecheck for NodeJS.
 Package nodejs implements compilecheck for NodeJS.
snippetgen/compilecheck/internal/php
Package php implements compilecheck for PHP.
 Package php implements compilecheck for PHP.
snippetgen/compilecheck/internal/py
Package py implements compilecheck for Python.
 Package py implements compilecheck for Python.
snippetgen/compilecheck/internal/ruby
Package ruby implements compilecheck for Ruby.
 Package ruby implements compilecheck for Ruby.
snippetgen/jsonpkger
Jsonpkger packages code fragments into JSON form.
 Jsonpkger packages code fragments into JSON form.
snippetgen/mergesnippets
Package main contains the main driver for the mergesnippets tool, which merges manual and automatic snippets into public snippets that can be published to GCS.
 Package main contains the main driver for the mergesnippets tool, which merges manual and automatic snippets into public snippets that can be published to GCS.
snippetgen/mergesnippets/snippet
Package snippet implements the Merger class to retrieve and merge secondary and primary snippets, and to publish the merged snippets.
 Package snippet implements the Merger class to retrieve and merge secondary and primary snippets, and to publish the merged snippets.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.