Update Diffing Display #1419
Merged
Update Diffing Display #1419
Conversation
This file contains 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
- update upstream directory names - add logging of staged directories
- reduces the length of diffed directories - uses short commit sha or up to 7 branch characters
|
is there a test we need to develop or update to make sure we don't regress this functionality in the future? |
|
We do not currently have tests over the specific parts of code I've touched here. However there are a few tests covering the complete diff functionality. I'm working on developing tests in parallel but wanted to create this first to get feedback on the experience it creates. |
- refactor shortSha - use one staging directory instead of three
mikebz
reviewed
Feb 10, 2021
mikebz
reviewed
Feb 10, 2021
internal/util/diff/diff.go
Outdated
| kptFile.Upstream.Git.Repo, | ||
| kptFile.Upstream.Git.Directory, | ||
| kptFile.Upstream.Git.Commit, | ||
| upstreamPkg) |
There was a problem hiding this comment.
same question as above. Do people expect to see the directory where things are staged after the "at..."
There was a problem hiding this comment.
The pkg variables store the path to the directory containing the staged package. This may be refactored in the future. The path is returned from the stageDirectory and GetPkg functions.
mikebz
reviewed
Feb 10, 2021
| } | ||
|
|
||
| // defaultPkgGetter uses get.Command abstraction to implement PkgGetter. | ||
| type defaultPkgGetter struct{} | ||
|
|
||
| func (pg defaultPkgGetter) GetPkg(repo, path, ref string) (string, error) { | ||
| dir, err := ioutil.TempDir("", "kpt-") | ||
| // GetPkg checks out a repository into a temporary directory for diffing |
There was a problem hiding this comment.
<3 the extra comments. Thanks for relaying the context!
mikebz
reviewed
Feb 10, 2021
- add accounting for some extra edge cases
|
After latest changes directories will be staged similar to: The
|
mortent
approved these changes
Feb 16, 2021
runewake2
added a commit
to runewake2/kpt
that referenced
this pull request
May 6, 2021
* Update diff info - update upstream directory names * Distinguish local and remote in dir names * Introduce a descriptive reference name in dir * Rename diffed directories - reduces the length of diffed directories - uses short commit sha or up to 7 branch characters * Update local diff path. * Create shared staging directory - refactor shortSha - use one staging directory instead of three * Add error handling for staging directory * Place staging dir naming under test - add accounting for some extra edge cases
runewake2
added a commit
that referenced
this pull request
May 13, 2021
* Update Diffing Display (#1419) * Update diff info - update upstream directory names * Distinguish local and remote in dir names * Introduce a descriptive reference name in dir * Rename diffed directories - reduces the length of diffed directories - uses short commit sha or up to 7 branch characters * Update local diff path. * Create shared staging directory - refactor shortSha - use one staging directory instead of three * Add error handling for staging directory * Place staging dir naming under test - add accounting for some extra edge cases * Update tests * Remove extra comment * Add help message when diff fails (#1466) * Add help message when diff fails * Remove unused code * Address Pr comments * Refactor tests * Update test to validate arguments * Fix linting error
frankfarzan
pushed a commit
to frankfarzan/kpt
that referenced
this pull request
Jun 3, 2021
* Update Diffing Display (kptdev#1419) * Update diff info - update upstream directory names * Distinguish local and remote in dir names * Introduce a descriptive reference name in dir * Rename diffed directories - reduces the length of diffed directories - uses short commit sha or up to 7 branch characters * Update local diff path. * Create shared staging directory - refactor shortSha - use one staging directory instead of three * Add error handling for staging directory * Place staging dir naming under test - add accounting for some extra edge cases * Update tests * Remove extra comment * Add help message when diff fails (kptdev#1466) * Add help message when diff fails * Remove unused code * Address Pr comments * Refactor tests * Update test to validate arguments * Fix linting error
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.
Attempts to improve the UX of kpt package diffs like experienced in #1377
update upstream directory names
kpt-12348765might now appear askpt-upstream-examples-cockroachdb-ProjectVersion-12348765where:upstreamreferences that the package was fetched from the source package. The local copy will appear aslocalinstead.examplesreferences the Git project name. In this case taken from: https://github.com/kubernetes/examplescockroachdbreferences the directory containing the upstream package. In this case taken from: staging/cockroachdbProjectVersionis a string constant that represents a version stored in the projects Kptfile. During remote or 3way diffs this may also appear as the provided reference (main,masteretc).add output of staged directories to stdout, this information looks like this:
PackageVersionrepresents a package which matches the package version stored in the projects Kptfilemasterwill represent the remote reference used during a 3way diff.There are some known issues with this approach: