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 ¶
const ( DefaultRemote = "https://github.com/snarlysodboxer/predictable-yaml-configs" RemoteFileName = ".remote" CacheDirName = ".cache" )
Variables ¶
This section is empty.
Functions ¶
func CachePath ¶ added in v1.0.0
CachePath returns the local cache directory path for a remote URL and version. Format: {configDir}/.cache/{host}/{owner}/{repo}/{ref}/
func FetchIfNeeded ¶
FetchIfNeeded checks the cache and fetches remote configs if not already cached. Returns the path to the cached config directory.
Types ¶
type LegacyRemoteConfig ¶ added in v1.0.0
LegacyRemoteConfig represents the contents of a .predictable-yaml/.remote file.
func ParseRemoteConfig ¶
func ParseRemoteConfig(path string) (*LegacyRemoteConfig, error)
ParseRemoteConfig reads and parses a .remote file.
Source Files