commit | 5b3d5514393e32c07843d14d52375a35d48b8824 | [log] [tgz] |
---|---|---|
author | Paul Jolly <paul@myitcv.io> | Mon Feb 01 14:33:07 2021 +0000 |
committer | Paul Jolly <paul@myitcv.org.uk> | Wed Feb 03 13:57:11 2021 +0000 |
tree | 3e2f1e8dbc56fc57bed8f1e3288a10ead0c9c041 | |
parent | 8d537aac8da50e37d27b3e4be401e3819fa95eb4 [diff] |
ci: refactor CI setup The current CI setup is complicated by the fact that we try to place go:generate directives in the directory (package) where the result is generated. This cannot really be satisfied because one of the generation targets is $modroot/.github/workflows. Per golang.org/issue/43985 this conflicts with the fact that go generate ./... would not cover such a target, and hence we need to wrap that go:generate directive in another that would be covered by ./... - which is messy. So instead: * consolidate all CI-related CUE tools in internal/ci * use go:generate directives in internal/ci for all CI-related generation, wrapping the CUE tools This is in preparation for changes that ensure we have go test coverage of the various GitHub workflow steps (import, validate, etc). So now if you: * change the workflow definitions in internal/ci, or * pin to a later version of the GitHub workflow schema just run: go generate ./internal/ci Change-Id: Idbc548c195746f5e021b5a0c1f3ad8773c5fa05f Reviewed-on: https://cue-review.googlesource.com/c/cue/+/8481 Reviewed-by: CUE cueckoo <cueckoo@gmail.com> Reviewed-by: Marcel van Lohuizen <mpvl@golang.org>
Configure, Unify, Execute
CUE is an open source data constraint language which aims to simplify tasks involving defining and using data.
It is a superset of JSON, allowing users familiar with JSON to get started quickly.
You can use CUE to
CUE merges the notion of schema and data. The same CUE definition can simultaneously be used for validating data and act as a template to reduce boilerplate. Schema definition is enriched with fine-grained value definitions and default values. At the same time, data can be simplified by removing values implied by such detailed definitions. The merging of these two concepts enables many tasks to be handled in a principled way.
Constraints provide a simple and well-defined, yet powerful, alternative to inheritance, a common source of complexity with configuration languages.
The CUE scripting layer defines declarative scripting, expressed in CUE, on top of data. This solves three problems: working around the closedness of CUE definitions (we say CUE is hermetic), providing an easy way to share common scripts and workflows for using data, and giving CUE the knowledge of how data is used to optimize validation.
There are many tools that interpret data or use a specialized language for a specific domain (Kustomize, Ksonnet). This solves dealing with data on one level, but the problem it solves may repeat itself at a higher level when integrating other systems in a workflow. CUE scripting is generic and allows users to define any workflow.
CUE is designed for automation. Some aspects of this are:
Using Homebrew, you can install using the CUE Homebrew tap:
brew install cuelang/tap/cue
If you already have Go installed, the short version is:
go get -u cuelang.org/go/cmd/cue
This will install the cue
command line tool.
For more details see Installing CUE.
The fastest way to learn the basics is to follow the tutorial on basic language constructs.
A more elaborate tutorial demonstrating of how to convert and restructure an existing set of Kubernetes configurations is available in written form.
Language Specification: official CUE Language specification.
API: the API on pkg.go.dev
Builtin packages: builtins available from CUE programs
cue
Command line reference: the cue
command
Our canonical Git repository is located at https://cue.googlesource.com.
To contribute, please read the Contribution Guide.
To report issues or make a feature request, use the issue tracker.
Changes can be contributed using Gerrit or Github pull requests.
You can get in touch with the cuelang community in the following ways:
Unless otherwise noted, the CUE source files are distributed under the Apache 2.0 license found in the LICENSE file.
This is not an officially supported Google product.