v4.0.0 #2120
hairyhenderson
started this conversation in
General
v4.0.0
#2120
Replies: 1 comment
-
|
It looks like the 32-bit builds aren't doing so well due to a bug in a dependency: #2121 I'm curious how many people actually use 32-bit builds though! |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
v4.0.0
🥳 It's finally here! Welcome to gomplate v4.0.0! This release is a major release, with breaking changes. Read on for more details...
Probably the most important feature that's evolved in gomplate over the years is its support for reading and parsing data from a variety of sources. Using URLs to specify where to find data has proven to be quite flexible, and has allowed for a lot of different data sources to be supported.
In early 2021, I took what I had learned from supporting all of these different data sources, and I created a new module called
go-fsimpl, which provides a number of Go filesystem implementations that can be used with Go's filesystem interfaces.My goal with
go-fsimplwas always to use it in gomplate, and now that it's data source support has reached parity with gomplate, it's time to make the switch! As a result, and becausego-fsimplpresents a much more consistent and unified approach to data sources, I've had to drop support for one data source, and in fixing some inconsistencies in how URLs have been handled by some of the data sources, I've had to make some breaking changes there as well.Breaking changes
Dropped support for the BoltDB data source
Support for the
boltdbURL scheme has been removed. The implementation was never very robust, and I'm not aware of anyone using it. It had some unique quirks that would have made it quite difficult to support ingo-fsimlas-is, so I've decided to drop it.No more
slimbinariesThe
slimbinaries were deprecated in v3.11, and will no longer be produced.Stricter URL handling
Subpaths are now always relative URLs
When using the
datasourcefunction with a subpath (second argument), the subpath has previously been intepreted by some data sources as a simple addition to the URL, and by others as a relative URL to be interpreted relative to the data source's base URL (as specified by the--datasourceflag).Now, all data sources will interpret the subpath as a relative URL, and will resolve it relative to the data source's base URL. This means that, given a base URL of
git+https://github.com/hairyhenderson/gomplate//randomand a subpath ofrandom.go, the resulting URL will begit+https://github.com/hairyhenderson/gomplate//random.go. To correct this, make sure that base URLs end with a trailing slash when the last component is a directory.Also, if the subpath begins with a slash, it will be interpreted as an absolute path, and will replace the base URL's path. For example, given a base URL of
git+file:///tmp/repos//myrepo/and a subpath of/myfile.txt, the resulting URL will begit+file:///myfile.txt. To correct this, make sure that subpaths don't begin with a slash. Note that for the special//separator indicating the separation between a Git repository and the path within, a subpath should now begin with.//rather than//.This affects at least the
gitandfiledata sources.Directories in datasource URLs must end with a slash
Previously, some data sources would assume URLs that end without a trailing slash are directories, and relative lookups would be performed within that directory. This was inconsistent with how URLs are normally interpreted, and could lead to unexpected results.
Now, all data sources will always interpret URLs without a trailing slash as files, and relative lookups will be performed within the parent directory of the URL.
For example, given a base URL of
vault:///secretand a subpath offoo, the resulting URL will bevault:///foo. To correct this, make sure that base URLs end with a trailing slash when the last component is a directory.Consistent data values
The
aws+smpdata source previously returned the AWS output object, with both metadata and data. Users needed to reference theValuefield to get the actual data. Now, theaws+smpdata source will return the data directly.The
consuldata source supports directory semantics, but previously returned all the data as a JSON array of key/value pair objects. Now, theconsuldata source will return directory listings like all other data sources, as a JSON array of strings (the names of the keys).Vault app-id authentication support removed
Support for the Vault "app-id" authentication method has been removed. This method was deprecated in Vault 0.6.1, and removed in Vault 1.13. If you're still using this method, you must switch to a different authentication method. Consider the "approle" method as a similar replacement.
The
suppressEmptybehaviour is now always enabledIn previous versions of gomplate, output that consist only of whitespace would by default still be written to files, with the
suppressEmptyflag orGOMPLATE_SUPPRESS_EMPTYenvironment variable being required to suppress this behaviour.Now, this behaviour is always enabled, and the
suppressEmptyflag andGOMPLATE_SUPPRESS_EMPTYenvironment variable have been removed.Log message formatting changes
A new logging framework is now in use (the standard library's
log/slogpackage), and so error and debug (--verbose) messages will appear differently (different colours for the console format, and key/value pairs may are sorted differently).Functions returning errors instead of quietly returning 0 on invalid input
Instead of quietly returning
0, a number of functions in theconvnamespace will now return an error if the input is invalid.This includes:
conv.ToInt64,conv.ToInt,conv.ToInt64s,conv.ToInts,conv.ToFloat64,conv.ToFloat64s,conv.ParseInt,conv.ParseFloat,conv.ParseUint,conv.AtoiBecause these functions are used by some other functions, this introduces stricter input validation for these functions:
coll.Flattencrypto.PBKDF2,crypto.Bcrypt,crypto.RSAGenerateKey,crypto.EncryptAES,crypto.DecryptAES,crypto.DecryptAESBytesmath.Abs,math.Add,math.Mul,math.Sub,math.Div,math.Rem,math.Pow,math.Seq,math.Max,math.Min,math.Ceil,math.Floor,math.Roundnet.CIDRHost,net.CIDRSubnets,net.CIDRSubnetSizesrandom.ASCII,random.Alpha,random.AlphaNum,random.String,random.Number,random.Floatregexp.FindAll,regexp.Splitstrings.Abbrev,strings.WordWraptime.Nanosecond,time.Microsecond,time.Millisecond,time.Second,time.Minute,time.HourFunctions in the
regexpnamespace now return errors instead of panickingPreviously, the
regexp.Matchandregexp.Replacefunctions would panic if the regular expression was invalid. Now, they will return an error instead.Removed functions
The following functions have been removed:
conv.Dict,conv.Slice,conv.Has- These have been deprecated since v3.2.0 and have been replaced withcoll.Dict,coll.Slice, andcoll.Has.Deprecations
See the deprecation policy.
slicealias forcoll.Slice(usecoll.Sliceinstead)net.Parse*functions which produced values from theinet.af/netaddrmodule have been deprecated and replaced with functions using the Go standard library'snet/netippackage:net.ParseIP(usenet.ParseAddrinstead)net.ParseIPPrefix(usenet.ParsePrefixinstead)net.ParseIPRange(usenet.ParseRangeinstead)AWS_META_ENDPOINTenvironment variable for overriding the IMDS endpoint inawsfunctions has been deprecated in favor of the AWS-nativeAWS_EC2_METADATA_SERVICE_ENDPOINT. This will be removed in a later v4 minor release (i.e. not in v4.0.0, but before v5).staticcheckwill help you find these in your code if you're using gomplate as a module. Follow the instructions in the deprecation comments to find out what to use instead.Thanks
Plenty of people have contributed to gomplate by filing issues, suggesting new features, or submitting pull requests. I'd like to especially thank the following people for submitting pull requests in this release:
Be sure to also check out the multi-platform Docker images available at
hairyhenderson/gomplate.If you've gained value out of gomplate and want to find a way to encourage development, please consider sponsoring gomplate!
v4.0.0 (2024-06-18)
Full Changelog (since v3.11)
Changes since v4.0.0-pre-3
Release Notes
New features and changes
funcspackage tointernal/funcs--exclude-processingoptioncoll.Picknow supports slice of strings as inputdata.Datatype with a datasource registrystrings.Indentto error on bad inputRunTemplatesfunction and oldConfigtypeConfigtype and updatedRunfunction and other API functionsregexpfunctionsconv.*functionstypequery parameter name withGOMPLATE_TYPE_PARAMenvironment variableNew functions
semverfunctions - thanks to @wuhuizuo!coll.Indexfunctioncoll.JQusing gojq library - thanks to @ahochsteger!strings.SkipLinesfunctioncoll.GoSliceand deprecateslicealiascoll.Setandcoll.UnsetfunctionsBug fixes
strings.Titlenot lowercase acronyms - thanks to @zregvart!Documentation fixes/updates
indexsupports nested keys - thanks to @isavcic!indexand.coll.GoSliceexample (fixes #1517)//are a good ideaMisc. internal contributions
t.Setenvto set env vars in tests - thanks to @Juneezee!github.com/Masterminds/semvertogithub.com/Masterminds/semver/v3- thanks to @wuhuizuo!This discussion was created from the release v4.0.0.
Beta Was this translation helpful? Give feedback.
All reactions