move ta-generator to task-generator directory

.github/workflows/check-buildah-remote.yaml

@@ -11,7 +11,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5
         with:
-          go-version-file: './task-generator/go.mod'
+          go-version-file: './task-generator/remote/go.mod'
       - name: Check buildah remote
         run: |
           ./hack/generate-buildah-remote.sh

.github/workflows/checkton.yaml

@@ -21,7 +21,7 @@ jobs:
           # Set to false when re-enabling SARIF uploads
           fail-on-findings: true
           find-copies-harder: true
-          exclude-regex: ^ta-generator
+          exclude-regex: ^task-generator
 
       # Currently, code scanning alerts annoyingly stay open even if you fix them.
       # Don't upload SARIF until https://github.com/orgs/community/discussions/132787 is resolved.

.github/workflows/go-ci.yaml

@@ -9,8 +9,8 @@ jobs:
     strategy:
       matrix:
         path:
-          - task-generator
-          - ta-generator
+          - task-generator/remote
+          - task-generator/trusted-artifacts
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc
       - uses: actions/setup-go@b26d40294f8ad76fcc90b915dac85892322fe62d
@@ -28,8 +28,8 @@ jobs:
     strategy:
       matrix:
         path:
-          - task-generator
-          - ta-generator
+          - task-generator/remote
+          - task-generator/trusted-artifacts
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc
       - name: Install Go
@@ -69,8 +69,8 @@ jobs:
     strategy:
       matrix:
         path:
-          - task-generator
-          - ta-generator
+          - task-generator/remote
+          - task-generator/trusted-artifacts
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc
       - uses: actions/setup-go@b26d40294f8ad76fcc90b915dac85892322fe62d

.gitignore

@@ -7,3 +7,12 @@ bundle_values.env
 *~
 *.swp
 .checkton.sarif
+**/vendor
+
+# expected and got files generated in trusted-artifacts tests when mismatch occurs
+task-generator/trusted-artifacts/golden/**/expected
+task-generator/trusted-artifacts/golden/**/got
+# Generated binaries
+task-generator/trusted-artifacts/trusted-artifacts
+task-generator/remote/remote
+

hack/generate-buildah-remote.sh

@@ -3,8 +3,8 @@ set -euo pipefail
 
 SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 
-cd "${SCRIPTDIR}/../task-generator"
-go build -o /tmp/remote-generator ./remote/main.go
+cd "${SCRIPTDIR}/../task-generator/remote"
+go build -o /tmp/remote-generator main.go
 
 for version in 0.1 0.2; do
     /tmp/remote-generator --buildah-task="${SCRIPTDIR}/../task/buildah/${version}/buildah.yaml" \

hack/generate-ta-tasks.sh

@@ -16,7 +16,7 @@ ROOT_DIR="$(git rev-parse --show-toplevel)"
 TASK_DIR="$(realpath "${ROOT_DIR}/task")"
 
 tashbin="$(mktemp --dry-run)"
-GOTOOLCHAIN=auto GOSUMDB=sum.golang.org go build -C "${ROOT_DIR}/ta-generator/" -o "${tashbin}"
+GOTOOLCHAIN=auto GOSUMDB=sum.golang.org go build -C "${ROOT_DIR}/task-generator/trusted-artifacts" -o "${tashbin}"
 trap 'rm "${tashbin}"' EXIT
 tash() {
   "${tashbin}" "$@"

task-generator/README.md

@@ -1,23 +1,4 @@
 # Task generator
-Task generator is a tool used for generating various versions of tasks. 
-
-## Buildah remote task generation
-The Buildah task builds source code into a container image and pushes the image into container registry using the Buildah tool. 
-While the standard Buildah task runs directly on the cluster, the remote task is run on a remote host. 
-This must be used in combination with the Multi Arch Controller, which provides the credentials and host name used to perform the build.
-
-The remote versions of the Buildah task are programmatically generated by this script from the buildah task to keep them in sync. The generated remote tasks should not be manually modified.
-
-### Arguments
-- `buildah-task` - The location of the buildah task YAML file (required)
-- `remote-task` - The location of the buildah-remote task YAML file to overwrite (required)
-- `task-version` - The version of the task to overwrite, e.g. `0.2` (required)
-
-Example usage: 
-```
-go run remote/main.go \
- --buildah-task ../task/buildah/0.2/buildah.yaml \
- --remote-task ../task/buildah-remote/0.2/buildah-remote.yaml \
- --task-version 0.2
-```
+The Task generator is a collection of tools used for generating various versions of tasks.
 
+Each tool has its own subdirectory with a README.

task-generator/remote/README.md

@@ -0,0 +1,21 @@
+# Buildah remote task generation
+The Buildah task builds source code into a container image and pushes the image into container registry using the Buildah tool.
+While the standard Buildah task runs directly on the cluster, the remote task is run on a remote host.
+This must be used in combination with the Multi Arch Controller, which provides the credentials and host name used to perform the build.
+
+The remote versions of the Buildah task are programmatically generated by this script from the buildah task to keep them in sync. The generated remote tasks should not be manually modified.
+
+This tool is used by the `hack/generate-buildah-remote.sh` script.
+
+## Arguments
+- `buildah-task` - The location of the buildah task YAML file (required)
+- `remote-task` - The location of the buildah-remote task YAML file to overwrite (required)
+- `task-version` - The version of the task to overwrite, e.g. `0.2` (required)
+
+Example usage:
+```
+go run remote/main.go \
+ --buildah-task ../task/buildah/0.2/buildah.yaml \
+ --remote-task ../task/buildah-remote/0.2/buildah-remote.yaml \
+ --task-version 0.2
+```

task-generator/go.mod → task-generator/remote/go.mod

@@ -1,4 +1,4 @@
-module github.com/konflux-ci/build-definitions/task-generator
+module github.com/konflux-ci/build-definitions/task-generator/remote
 
 go 1.22.0
 

task-generator/trusted-artifacts/README.md

@@ -0,0 +1,30 @@
+# Trusted Artifacts variants generator
+
+## Description
+
+This tool is used for the generation of trusted artifacts variants of a task.
+It will process a set of directions in `recipe.yaml` file and
+based on that and a set of builtin conventions generate the Tekton Task
+definition in YAML format.
+
+This tool is used by the `hack/generate-ta-tasks.sh` script.
+
+## Usage
+
+The tool uses only one argument - path to the `recipe.yaml` file.
+These `recipe.yaml` files are stored in the task directories ending with `-oci-ta`.
+
+Usage (from the `task-generator/trusted-artifacts` directory)
+```
+go run . path/to/recipe.yaml
+```
+
+The generated Trusted Artifacts Task is provided on the standard output.
+
+## Testing
+
+There are various included tests in the `golden` folder. 
+They use the `base.yaml` file which gets modified based on the `recipe.yaml` and is compared to the `ta.yaml`
+```
+go test ./...
+```

ta-generator/go.mod → task-generator/trusted-artifacts/go.mod

@@ -1,4 +1,4 @@
-module github.com/konflux-ci/build-definitions/ta-generator
+module github.com/konflux-ci/build-definitions/task-generator/trusted-artifacts
 
 go 1.22.3