tektoncd / tektoncd/chains

Move tools.go to its own module

Open
#1,097 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
277
Forks
164
Avg merge
2d 3h
Merged PRs (30d)
61

Description

As mentioned in the docs for tools.go, the dependencies used there are only meant to be used in scripts. Let's isolate those dependencies in their own go module to formalize their usage.

We could turn the parent directoy, hack, into a go module, for example. This would likely require changes in other scripts and maybe CI.

The main benefit of this approach is that CVEs found in those dependencies do not impact the Chains controller.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the documentation and implementation of hack/tools.go, then inspect the other scripts and CI configuration that invoke it. Move the script dependencies into a separate Go module, update affected scripts and CI as needed, and verify that the controller is no longer impacted by those dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
build-system, ci-cd, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.