openshift / openshift/machine-config-operator

get rid of ./lib/* fork

Open
#819 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

lifecycle/frozen
Dominant language
Go
Stars
269
Forks
529
Avg merge
3d 18h
Merged PRs (30d)
83

Description

This somehow depends on #588 but can be done w/o that finished as well. Code under ./lib is basically a fork of an old project that now fully lives in openshift/library-go.

We need to:

  • Fix #588 (but again, this issue can be done 99% w/o that)
  • Move existing code to use openshift/library-go/pkg/operator/resource/* for core types
  • drop ./lib

As of today, since #588 isn't done yet, we can work on the second point above as follows:

  • Move existing code to use openshift/library-go/pkg/operator/resource/* for core types (instead of our ./lib/resource* packages)
  • leave under ./lib just ./lib/*/machineconfig* files, types and funcs since we still need those till #588 is done
  • while removing funcs from the above, contribute any core func to library-go as well (if any, haven't checked).

Example:

Move https://github.com/openshift/machine-config-operator/blob/fcf5aa07db58710cb22093deb1ef2dad320bf3eb/pkg/operator/sync.go#L80 to https://github.com/openshift/library-go/blob/master/pkg/operator/resource/resourceapply/apiextensions.go#L32 (applies for resourceread package and the others as well in the surrounding lines)

Contributor guide

No contributing guide indexed for this repository

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 by comparing pkg/operator/sync.go and the surrounding ./lib/resource* packages with the corresponding openshift/library-go/pkg/operator/resource/* packages, including resourceread and resourceapply. The work is done when core code uses library-go, ./lib retains only the machineconfig files, types, and functions needed until #588, and any remaining core functions are contributed to library-go.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.