Documentation
¶
Overview ¶
Package ruby provides Ruby specific functionality for librarian.
Index ¶
- func Add(cfg *config.Config, lib *config.Library) (*config.Library, error)
- func AddManifest(manifest map[string]string, name, version string) map[string]string
- func AddPackage(packages map[string]any, name string) map[string]any
- func Clean(library *config.Library) error
- func DefaultOutput(name, defaultOutput string) string
- func Format(ctx context.Context, library *config.Library) error
- func Generate(ctx context.Context, cfg *config.Config, library *config.Library, ...) (err error)
- func Install(ctx context.Context, tools *config.Tools) error
- func InstallDir() (string, error)
- func Tidy(lib *config.Library) (*config.Library, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddManifest ¶ added in v0.32.0
AddManifest inserts a new package and its filler entry into a Release Please manifest map.
func AddPackage ¶ added in v0.32.0
AddPackage inserts a new package into a Release Please packages map.
func Clean ¶
Clean removes generated files and directories from beneath the given library's output directory. If the output directory does not currently exist, this function is a no-op.
func DefaultOutput ¶ added in v0.30.1
DefaultOutput derives an output path from a library name and a default output path.
func Generate ¶
func Generate(ctx context.Context, cfg *config.Config, library *config.Library, srcs *sources.Sources) (err error)
Generate generates a Ruby client library.
func InstallDir ¶ added in v0.26.0
InstallDir gets the directory where tools should be installed.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.