internal/ci: make the writing of files reusable

This moves the code around, so that ci_tool.cue becomes a thin wrapper.
We will add more useful reusable bits to write.cue soon.

Signed-off-by: Daniel Martí <[email protected]>
Change-Id: I18df6a99c483fbd3f8877770b0ffd8a7aeab853b
Reviewed-on: https://cue.gerrithub.io/c/cue-lang/cue/+/1219413
Reviewed-by: Paul Jolly <[email protected]>
Unity-Result: CUE porcuepine <[email protected]>
TryBot-Result: CUEcueckoo <[email protected]>

Author: mvdan

.github/workflows/push_tip_to_trybot.yaml

@@ -1,4 +1,4 @@
-# Code generated internal/ci/ci_tool.cue; DO NOT EDIT.
+# Code generated internal/ci/base/write.cue; DO NOT EDIT.
 
 concurrency: push_tip_to_trybot
 jobs:

.github/workflows/release.yaml

@@ -1,4 +1,4 @@
-# Code generated internal/ci/ci_tool.cue; DO NOT EDIT.
+# Code generated internal/ci/base/write.cue; DO NOT EDIT.
 
 name: Release
 concurrency: release

.github/workflows/tip_triggers.yaml

@@ -1,4 +1,4 @@
-# Code generated internal/ci/ci_tool.cue; DO NOT EDIT.
+# Code generated internal/ci/base/write.cue; DO NOT EDIT.
 
 name: Triggers on push to tip
 "on":

.github/workflows/trybot.yaml

@@ -1,4 +1,4 @@
-# Code generated internal/ci/ci_tool.cue; DO NOT EDIT.
+# Code generated internal/ci/base/write.cue; DO NOT EDIT.
 
 name: TryBot
 "on":

.github/workflows/trybot_dispatch.yaml

@@ -1,4 +1,4 @@
-# Code generated internal/ci/ci_tool.cue; DO NOT EDIT.
+# Code generated internal/ci/base/write.cue; DO NOT EDIT.
 
 name: Dispatch trybot
 "on":

codereview.cfg

@@ -1,4 +1,4 @@
-# Code generated internal/ci/ci_tool.cue; DO NOT EDIT.
+# Code generated internal/ci/base/write.cue; DO NOT EDIT.
 
 cue-unity: https://github.com/cue-unity/unity-private
 github: https://github.com/cue-lang/cue

internal/ci/base/base.cue

@@ -107,7 +107,7 @@ codeReview: #codeReview & {
 // crucial. As such, we assert specific values for the keys here rather than
 // just deriving values from the human-readable names.
 //
-// trybot.name is by the trybot GitHub workflow and by gerritstatusupdater as
+// trybot.name is used by the trybot GitHub workflow and by gerritstatusupdater as
 // an identifier in the status updates that are posted as reviews for this
 // workflows, but also as the result label key, e.g.  "TryBot-Result" would be
 // the result label key for the "TryBot" workflow. This name also shows up in

internal/ci/base/write.cue

@@ -0,0 +1,72 @@
+// Copyright 2021 The CUE Authors
+//
+// 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.
+
+package base
+
+import (
+	"path"
+	"encoding/yaml"
+	"tool/file"
+
+	"cue.dev/x/githubactions"
+)
+
+// For the commands below, note we use simple yet hacky path resolution, rather
+// than anything that might derive the module root using go list or similar, in
+// order that we have zero dependencies.  This is important because this CUE
+// package is "vendored" to an external dependency so that that unity can
+// re-run and verify these steps as part of the test suite that runs against
+// new CUE versions.
+
+// TODO(mvdan): without the default, this doesn't seem to be filled by
+// `cue cmd gen` in internal/ci, even though the command defaults --inject-vars to true.
+// Perhaps it doesn't work for imported packages? It seems to me like it should.
+_goos: string | *path.Unix @tag(os,var=os)
+
+// writeWorkflows regenerates the GitHub workflow YAML definitions.
+writeWorkflows: {
+	#in: {
+		workflows: [string]: githubactions.#Workflow
+	}
+	_dir: path.FromSlash("../../.github/workflows", path.Unix)
+	
+	remove: {
+		glob: file.Glob & {
+			glob: path.Join([_dir, "*" + workflowFileExtension], _goos)
+			files: [...string]
+		}
+		for _, _filename in glob.files {
+			"delete \(_filename)": file.RemoveAll & {
+				path: _filename
+			}
+		}
+	}
+	for _workflowName, _workflow in #in.workflows {
+		let _filename = _workflowName + workflowFileExtension
+		"generate \(_filename)": file.Create & {
+			$after: [for v in remove {v}]
+			filename: path.Join([_dir, _filename], _goos)
+			let donotedit = doNotEditMessage & {#generatedBy: "internal/ci/base/write.cue", _}
+			contents: "# \(donotedit)\n\n\(yaml.Marshal(_workflow))"
+		}
+	}
+}
+
+writeCodereviewCfg: file.Create & {
+	_dir: path.FromSlash("../../", path.Unix)
+	filename: path.Join([_dir, "codereview.cfg"], _goos)
+	let res = toCodeReviewCfg & {#input: codeReview, _}
+	let donotedit = doNotEditMessage & {#generatedBy: "internal/ci/base/write.cue", _}
+	contents: "# \(donotedit)\n\n\(res)\n"
+}

internal/ci/ci_tool.cue

@@ -15,60 +15,16 @@
 package ci
 
 import (
-	"path"
-	"encoding/yaml"
-	"tool/file"
-
-	"github.com/cue-lang/tmp/internal/ci/base"
 	"github.com/cue-lang/tmp/internal/ci/repo"
 	"github.com/cue-lang/tmp/internal/ci/github"
 )
 
-// For the commands below, note we use simple yet hacky path resolution, rather
-// than anything that might derive the module root using go list or similar, in
-// order that we have zero dependencies.  This is important because this CUE
-// package is "vendored" to an external dependency so that that unity can
-// re-run and verify these steps as part of the test suite that runs against
-// new CUE versions.
-
-_goos: string @tag(os,var=os)
-
-// gen.workflows regenerates the GitHub workflow Yaml definitions.
-//
 // See internal/ci/gen.go for details on how this step fits into the sequence
 // of generating our CI workflow definitions, and updating various txtar tests
 // with files from that process.
-command: gen: {
-	_dir: path.FromSlash("../../.github/workflows", path.Unix)
 
-	workflows: {
-		remove: {
-			glob: file.Glob & {
-				glob: path.Join([_dir, "*" + base.workflowFileExtension], _goos)
-				files: [...string]
-			}
-			for _, _filename in glob.files {
-				"delete \(_filename)": file.RemoveAll & {
-					path: _filename
-				}
-			}
-		}
-		for _workflowName, _workflow in github.workflows {
-			let _filename = _workflowName + repo.workflowFileExtension
-			"generate \(_filename)": file.Create & {
-				$after: [for v in remove {v}]
-				filename: path.Join([_dir, _filename], _goos)
-				let donotedit = repo.doNotEditMessage & {#generatedBy: "internal/ci/ci_tool.cue", _}
-				contents: "# \(donotedit)\n\n\(yaml.Marshal(_workflow))"
-			}
-		}
-	}
-}
+command: gen: {
+	workflows: repo.writeWorkflows & {#in: workflows: github.workflows}
 
-command: gen: codereviewcfg: file.Create & {
-	_dir: path.FromSlash("../../", path.Unix)
-	filename: path.Join([_dir, "codereview.cfg"], _goos)
-	let res = repo.toCodeReviewCfg & {#input: repo.codeReview, _}
-	let donotedit = repo.doNotEditMessage & {#generatedBy: "internal/ci/ci_tool.cue", _}
-	contents: "# \(donotedit)\n\n\(res)\n"
+	codereviewCfg: repo.writeCodereviewCfg
 }