fix: include subdirectories in example templates #1715
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
deansheather
approved these changes
May 25, 2022
examples/examples.go
Outdated
Comment on lines
172
to
175
| _, err = tarWriter.Write(data) | ||
| if err != nil { | ||
| return xerrors.Errorf("write: %w", err) | ||
| } |
There was a problem hiding this comment.
You should be able to io.Copy instead to avoid the extra buffer
examples/examples.go
Outdated
| if err != nil { | ||
| return xerrors.Errorf("open file %s: %w", path, err) | ||
| } | ||
| _, err = file.Read(data) |
There was a problem hiding this comment.
This doesn't matter if you use io.Copy, but in the future you should use io.ReadAll instead, because Read isn't guaranteed to fill your output buffer
| @@ -154,22 +155,17 @@ func Archive(exampleID string) ([]byte, error) { | |||
| } else { | |||
| header.Name = path | |||
|
|
|||
| data := make([]byte, info.Size()) | |||
| file, err := exampleFiles.Open(path) | |||
| if err != nil { | |||
| return xerrors.Errorf("open file %s: %w", path, err) | |||
| } | |||
There was a problem hiding this comment.
Should be closed i.e. defer file.Close()
There was a problem hiding this comment.
Good point. Technically I think we would be OK without it, because the readers returned by embed.FS are just pointers, but I added it anyway to make the code more obviously correct.
johnstcn
approved these changes
May 25, 2022
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.
This PR makes
coder templates initcorrectly include files in subdirectories of examples.Subtasks
examples/templatesand updated package to embed that entire directoryexamples.Archiveto recursively walk directoriesFixes #1669