opentofu/internal/getmodules/doc.go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

// Package getmodules contains the low-level functionality for fetching
// remote module packages. It's essentially just a thin wrapper around
// go-getter.
//
// This package is only for remote module source addresses, not for local
// or registry source addresses. The other address types are handled
// elsewhere.
package getmodules
[COMPLIANCE] Add Copyright and License Headers 2023-05-02 10:33:06 -05:00			`// Copyright (c) HashiCorp, Inc.`
			`// SPDX-License-Identifier: MPL-2.0`

getmodules: Beginnings of a new package about Terraform module packages This new package aims to encapsulate all of our interactions with go-getter to fetch remote module packages, to ensure that the rest of Terraform will only use the small subset of go-getter functionality that our modern module installer uses. In older versions of Terraform, go-getter was the entire implementation of module installation, but along the way we found that several aspects of its design are poor fit for Terraform's needs, and so now we're using it as just an implementation detail of Terraform's handling of remote module packages only, hiding it behind this wrapper API which exposes only the services that our module installer needs. This new package isn't actually used yet, but in a later commit we will change all of the other callers to go-getter to only work indirectly through this package, so that this will be the only package that actually imports the go-getter packages. 2021-05-27 20:07:09 -05:00			`// Package getmodules contains the low-level functionality for fetching`
			`// remote module packages. It's essentially just a thin wrapper around`
			`// go-getter.`
			`//`
			`// This package is only for remote module source addresses, not for local`
			`// or registry source addresses. The other address types are handled`
			`// elsewhere.`
			`package getmodules`