remote

package
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Apr 21, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Copyright © 2022 david amick git@davidamick.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source
const (
	DefaultRemote  = "https://github.com/snarlysodboxer/predictable-yaml-configs"
	RemoteFileName = ".remote"
	CacheDirName   = ".cache"
)

Variables

This section is empty.

Functions

func FetchIfNeeded

func FetchIfNeeded(rc *RemoteConfig, configDir string) (string, error)

FetchIfNeeded checks the cache and fetches remote configs if not already cached. Returns the path to the cached config directory.

Types

type RemoteConfig

type RemoteConfig struct {
	Remote  string `yaml:"remote"`
	Version string `yaml:"version"`
}

RemoteConfig represents the contents of a .predictable-yaml/.remote file.

func ParseRemoteConfig

func ParseRemoteConfig(path string) (*RemoteConfig, error)

ParseRemoteConfig reads and parses a .remote file.

func (*RemoteConfig) CachePath

func (rc *RemoteConfig) CachePath(configDir string) (string, error)

CachePath returns the local cache directory path for this remote config. Format: {configDir}/.cache/{host}/{owner}/{repo}/{ref}/

Jump to

Keyboard shortcuts

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