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.

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

release strategy for logcheck #312

Closed
pohly opened this issue Mar 20, 2022 · 9 comments · Fixed by #330
Closed

release strategy for logcheck #312

pohly opened this issue Mar 20, 2022 · 9 comments · Fixed by #330
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@pohly
Copy link

pohly commented Mar 20, 2022

/kind feature

Right now, logcheck doesn't get released "properly" (no tag, no release notes). Kubernetes imports it via the commit hash (https://github.com/kubernetes/kubernetes/blob/0ade4678a7ba527d22f6baa81034dea423267608/hack/tools/go.mod#L14).

We could:

  • tag it with hack/tools/v0.1.0
  • move it to a separate repo
  • do nothing and keep importing it via hash

Describe the solution you'd like

According to the discussion in kubernetes/kubernetes#108725 (comment), a separate repo seems more appropriate. There is no technical reason why the tool is in klog and releases are easier when it is a stand-alone repo.

@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 20, 2022
@pohly
Copy link
Author

pohly commented Mar 24, 2022

Jordan's preference is to move it to a separate repo.

@dims
Copy link
Member

dims commented Mar 24, 2022

+1 from me (separate repo)

@RinkiyaKeDad
Copy link
Member

I can help with this. We'd need to create a PR to https://github.com/kubernetes/org for the repo request. Are we fine with simply taking the current code and starting fresh in a new repo, that is, not preserving the commit history?

/assign

@pohly
Copy link
Author

pohly commented Mar 24, 2022

Let's preserve history. Git can do it and there is valuable information in the commit history that shouldn't get lost.

I would to it with "git format-patch hack/tools/logcheck", mangling paths, and "git am". There are of course other options.

@pohly
Copy link
Author

pohly commented Mar 24, 2022

FWIW, +1 from me for moving to a separate repo.

@pohly
Copy link
Author

pohly commented Mar 24, 2022

What should be the name of the new repo? Just k8s.io/logcheck and thus just one tool in that repo or k8s.io/logtools with a logcheck directory?

I can see pros and cons for both: simpler structure, shorter path and release process when using k8s.io/logcheck, more flexibility when using k8s.io/logtools.

@dims
Copy link
Member

dims commented Mar 24, 2022

@pohly need to poke the sig-instrumentation leads i think as they will be the owner?

@pohly
Copy link
Author

pohly commented Mar 24, 2022

@RinkiyaKeDad: can you drive this, including the discussion on #sig-instrumentation regarding the repo?

@RinkiyaKeDad
Copy link
Member

Yup, I can take care of that! Will continue this discussion about the repo name there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants