Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cleanup: breakup the pkg/credentials into writer and matcher #8542

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

cleanup: breakup the pkg/credentials into writer and matcher #8542

wants to merge 3 commits into from

Conversation

waveywaves
Copy link
Member

@waveywaves waveywaves commented Jan 30, 2025 •
edited
Loading

Changes

The credentials package contains the a matcher and a writer which out of which only the writer is used in cmd/entrypoint. In an effort to isolate usage and not indirectly import the corev1 api which the matcher uses for MatchingAnnotations, we are breaking up the credentials builder interface into two builders for writer and matcher.

This ensures that the entrypoint only uses the writer and not the matcher, and we are only using either the writer or the matcher functionality as necessary and not importing unnecessary deps.

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • pre-commit Passed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

/kind cleanup

Release Notes

import only the writer part of the credentials package in the entrypoint so that we do not pull core v1 API indirectly into the package

@waveywaves
cleanup: breakup the pkg/credentials into writer and matcher
9e090f3 
The credentials package contains the a matcher and a writer which out of
which only the writer is used in cmd/entrypoint. In an effort to isolate
usage and not indirectly import the corev1 api which the matcher uses
for MatchingAnnotations, we are breaking up the credentials builder interface
into two builders for writer and matcher.

This ensures that the entrypoint only uses the writer and not the matcher,
and we are only using either the writer or the matcher functionality
as necessary and not importing unnecessary deps.
@tekton-robot
Copy link
Collaborator

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@tekton-robot tekton-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jan 30, 2025
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign vdemeester after the PR has been reviewed.
You can assign the PR to them by writing /assign @vdemeester in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 30, 2025
@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jan 30, 2025
@waveywaves waveywaves mentioned this pull request Jan 30, 2025
Open
4 tasks
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/credentials/gitcreds/creds.go 94.7% 94.4% -0.3
pkg/credentials/matcher/matcher.go Do not exist 0.0%
pkg/credentials/matcher/matcher.go Do not exist 100.0%
pkg/credentials/matcher/matcher.go Do not exist 100.0%
pkg/credentials/matcher/matcher.go Do not exist 20.0%
pkg/credentials/matcher/matcher.go Do not exist 0.0%
pkg/credentials/writer/writer.go Do not exist 46.0%

vdemeester
vdemeester reviewed Jan 30, 2025
View reviewed changes
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good start ❤️ Needs a bit more work but it's definitely going into the right direction.

cmd/entrypoint/main.go
@@ -33,9 +33,9 @@ import (
featureFlags "github.com/tektoncd/pipeline/pkg/apis/config"
"github.com/tektoncd/pipeline/pkg/apis/pipeline"
v1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
"github.com/tektoncd/pipeline/pkg/credentials"
"github.com/tektoncd/pipeline/pkg/credentials/dockercreds"
"github.com/tektoncd/pipeline/pkg/credentials/gitcreds"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will need to do the same for credentials/{dockercreds,gitcreds… 👼🏼

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what you mean 🤔 😅

pkg/credentials/matcher/matcher.go Outdated Show resolved Hide resolved
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/credentials/gitcreds/creds.go 94.7% 94.4% -0.3
pkg/credentials/matcher/matcher.go Do not exist 0.0%
pkg/credentials/matcher/matcher.go Do not exist 100.0%
pkg/credentials/matcher/matcher.go Do not exist 50.0%
pkg/credentials/matcher/matcher.go Do not exist 20.0%
pkg/credentials/matcher/matcher.go Do not exist 0.0%
pkg/credentials/writer/writer.go Do not exist 46.0%

@waveywaves waveywaves marked this pull request as ready for review February 3, 2025 11:23
jkhelil
jkhelil reviewed Feb 3, 2025
View reviewed changes
cmd/entrypoint/main.go Outdated Show resolved Hide resolved
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/credentials/gitcreds/creds.go 94.7% 94.4% -0.3
pkg/credentials/matcher/matcher.go Do not exist 100.0%
pkg/credentials/matcher/matcher.go Do not exist 0.0%
pkg/credentials/matcher/matcher.go Do not exist 100.0%
pkg/credentials/matcher/matcher.go Do not exist 0.0%
pkg/credentials/matcher/matcher.go Do not exist 50.0%
pkg/credentials/matcher/matcher.go Do not exist 0.0%
pkg/credentials/writer/writer.go Do not exist 46.0%

@vdemeester
Copy link
Member

/retest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jkhelil jkhelil jkhelil left review comments

@vdemeester vdemeester vdemeester left review comments

@pritidesai pritidesai Awaiting requested review from pritidesai

Assignees
No one assigned
Labels
do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Tekton Community Roadmap
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@waveywaves @tekton-robot @vdemeester @jkhelil