docs: add development-tips.md #55
Conversation
CodeMonkeyLeet
requested review from
jeremyrickard,
salaxander and
sozercan
as code owners
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #55 +/- ##
=======================================
Coverage 34.45% 34.45%
=======================================
Files 12 12
Lines 1126 1126
=======================================
Hits 388 388
Misses 717 717
Partials 21 21 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Signed-off-by: Simon Leet <simon.leet@microsoft.com>
CodeMonkeyLeet
force-pushed
the
add_dev_tips
branch
from
4f98244
to
31e0760
Compare
|
@CodeMonkeyLeet can we move this to the website docs so it's more visible? |
|
|
||
| ### Extract files from the image to inspect them | ||
|
|
||
| `dive` won't let you read the contents of the files in the image though; to do that, you can use the `docker cp` command to copy the files out of the image to a local folder. Note that `docker cp` only works with containers and not just container images, so you will need to create a container from the image and then copy the files out of the container: |
There was a problem hiding this comment.
I have been using crane export to dump the filesystem. Should we mention this instead of docker cp?
You can also see diffs using
diff \
<(crane export foo:bar - | tar -tvf - | sort) \
<(crane export foo:bar-patched - | tar -tvf - | sort)
There was a problem hiding this comment.
I'll add it to the doc because crane export is a good way to explore the entire filesystem interactively, but I switched away from extracting the entire image in my workflow because there's usually only a couple of files I want to inspect, and the dive exploration view is really handy for the per layer diffing.
Also, neat diff command line, thanks for sharing that!
I'm open to it, I'll leave it to @salaxander's discretion. For other projects I've worked on, maintainer-facing docs tend to be in the repo and user-facing docs tend to be in the docs site. |
Signed-off-by: Simon Leet <simon.leet@microsoft.com>
Add documentation for debugging and testing changes to
copa.