Update bitrise-init #148
Update bitrise-init #148
Conversation
| @@ -10,6 +10,17 @@ app: | |||
| workflows: | |||
| # ---------------------------------------------------------------- | |||
| # --- workflow to Step Test | |||
| sample: | |||
| envs: | |||
| - PROJECT_DIR: "<local_project_dir>" | |||
There was a problem hiding this comment.
This <local_project_dir> is just a placeholder and the developer need to replace it, right? If it is then can you add a comment highlighting this?
(Because I had to look at this too long to realise that this is most probably a placeholder 😂)
main.go
Outdated
| if err := resultClient.uploadResults(result); err != nil { | ||
| failf("Could not send back results: %s", err) | ||
| var resultBytes []byte | ||
| shouldStoreResult := resultClient != nil || strings.HasPrefix(cfg.ResultSubmitURL, "path::") |
There was a problem hiding this comment.
I like how you extracted this into a named boolean variable which helps readability a lot. Can you do the same with the path prefix check because it is also used at 4 different places and if we name it then it will be much faster to understand what it means. Something like
isLocalSave := strings.HasPrefix(cfg.ResultSubmitURL, "path::")
main.go
Outdated
| log.TInfof("Submitting results...") | ||
| if err := resultClient.uploadResults(result); err != nil { | ||
| failf("Could not send back results: %s", err) | ||
| var resultBytes []byte |
There was a problem hiding this comment.
This variable is not used outside of the if statement below so I think it can be moved from here to there.
main.go
Outdated
| var resultBytes []byte | ||
| shouldStoreResult := resultClient != nil || strings.HasPrefix(cfg.ResultSubmitURL, "path::") | ||
| if shouldStoreResult { | ||
| resultBytes, err = json.MarshalIndent(result, "", "\t") |
There was a problem hiding this comment.
I know it is only whitespace but this will change the format of the result a bit. Just double checking that whatever component relies on this result in our system can still read it, right?
There was a problem hiding this comment.
This is the current format: https://github.com/bitrise-steplib/steps-project-scanner/blob/master/submitresult.go#L91
I didn't plan to change it with this PR.
submitresult.go
Outdated
|
|
||
| func (c *resultClient) uploadResults( /*result models.ScanResultModel, */ bytes []byte) error { |
There was a problem hiding this comment.
I guess this commented out parameter can be removed.
main.go
Outdated
| } | ||
|
|
||
| log.TDonef("Results submitted.") | ||
| } else if strings.HasPrefix(cfg.ResultSubmitURL, "path::") { |
There was a problem hiding this comment.
It was not clear at first what this new local save feature means. Can you add some explanation that this is not used in prod and it is mostly for local testing with the sample workflow?
Checklist
step.ymlandREADME.mdis updated with the changes (if needed)Version
Requires a MAJOR version update
Context
This PR updates bitrise-init, which brings new Xcode scheme listing logic to the project scanner.
Changes