readme: added instructions for sync #538
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
klaskosk
requested review from
kononovn,
trewest,
achuzhoy and
cdvultur
as code owners
kononovn
requested changes
Jul 29, 2024
achuzhoy
reviewed
Jul 29, 2024
README.md
Outdated
|
|
||
| #### Running | ||
|
|
||
| To run the sync tool, use the makefile target. |
There was a problem hiding this comment.
Suggested change
| To run the sync tool, use the makefile target. | |
| To run the sync tool, use the lib-sync makefile target. |
achuzhoy
reviewed
Jul 29, 2024
README.md
Outdated
|
|
||
| ### Sync Tool and Operator Types | ||
|
|
||
| To switch to using just the runtime client and to remove dependencies on individual operators, the sync tool will periodically copy over types from operator repos to this repo. It works by cloning the operator repo, applying changes in the config file, then copying it into this repo. |
There was a problem hiding this comment.
So we clone the whole repo just for one file? Why not just get the single file
There was a problem hiding this comment.
@achuzhoy We do a sparse checkout but I'll update to mention that
achuzhoy
reviewed
Jul 29, 2024
README.md
Outdated
| 7. Since the operator may import other parts of the repo or other repos in the same organization, this will need to be replaced with imports from eco-goinfra once synced. | ||
| 8. Import replacement is done through find and replace, so we include the double quotes to make sure it is an import being matched. | ||
| 9. If the package name in eco-goinfra is different than the operator repo, the import should be renamed so the code still works. | ||
| 10. Excludes is a list of file patterns to exclude. Since tests and mocks may add their own dependencies, excluding them can keep the amount of code that needs synced much smaller |
There was a problem hiding this comment.
seems like "that needs synced much smaller" needs re-phrasing?
achuzhoy
reviewed
Jul 29, 2024
trewest
reviewed
Jul 29, 2024
trewest
reviewed
Jul 29, 2024
trewest
reviewed
Jul 29, 2024
trewest
reviewed
Jul 29, 2024
achuzhoy
reviewed
Jul 29, 2024
README.md
Outdated
| 4. Branch is the branch of the operator repo to sync with. | ||
| 5. Remote API directory is the path in the operator repo to sync with, relative to the operator repo root. | ||
| 6. Local API directory is the path in eco-goinfra where the remote API directory should be synced to. Relative to the eco-goinfra root, it should start with `schemes/`. | ||
| 7. Since the operator may import other parts of the repo or other repos in the same organization, these will need to be replaced with imports from eco-goinfra once synced. This field is optional. |
There was a problem hiding this comment.
Not clear what needs to be done exactly.
There was a problem hiding this comment.
@achuzhoy Which part is unclear? Like what the values should be for this field or when you need to provide them?
There was a problem hiding this comment.
" these will need to be replaced with imports from eco-goinfra once synced" replaced with what?
There was a problem hiding this comment.
@achuzhoy I've updated the PR to help clarify this
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rendered