[TIMOB-16631] CLI: Add information type `environment` to `ti info`
| GitHub Issue | n/a |
|---|---|
| Type | New Feature |
| Priority | Low |
| Status | Closed |
| Resolution | Fixed |
| Resolution Date | 2014-11-19T08:29:54.000+0000 |
| Affected Version/s | Release 3.2.1 |
| Fix Version/s | Release 4.0.0 |
| Components | CLI |
| Labels | cli, developers, ft, jira, q&a |
| Reporter | Fokke Zandbergen |
| Assignee | Chris Barber |
| Created | 2014-02-23T18:56:39.000+0000 |
| Updated | 2015-03-19T20:40:15.000+0000 |
Description
For both JIRA an Q&A it would be helpful if the CLI
info command had an information type (-t) that would spit out a summary of the most important information on the environment, like - but not limited to:
- OS name and version
- Selected SDK
- CLI and Node.js version
- Studio version
- Warnings and critical issues
This information should include the 90% needed to clarify bug reports and Q's in a copy-paste friendly format. I would also suggest to include this summary at the end of the full (ti info or ti info -t all) report.
The JIRA Environment field description and the [Q&A submit-form](http://developer.appcelerator.com/question/ask) should be updated to ask for this information.
Additionally, it would be awesome if the build command would get the same --report flag [as Hyperloop](https://github.com/appcelerator/hyperloop/blob/master/lib/log.js#L103) to include both the above and the app-specific information.
Moving this enhancement request to engineering for further evaluation.
[~fokke] We believe that all of the above information is now captured in "ti info" (with the exception of Studio version). Does that match your understanding? If so, is this ticket then just about adding --report? Note that we submit tickets into JIRA as opposed to GitHub. Would this then create a TC ticket?
I don't really see the value in
\-\-reportflag. If you ran a build and it failed, it's too late to go back and add the\-\-reportflag. Furthermore, Studio isn't going to pass it in. What we need is a build.log file that contains the entire log output plus the info fromti infoandti setup check. Part of the problem is the logger is garbage and needs to be overhauled to support printing to the console and log files. I've got a ticket to add this: TIMOB-12169. My recommendation is to just resolve this ticket as won't fix and let's add support for build.log files. Thoughts?Ingo, the "ti info" includes lots of information not relevant to debug a build error. Too much to ask users to paste in the environment box of a JIRA ticket I'd think. What I like about the --report flag of Hyperloop is that it includes both environment and process info related to the error. Chris, only if the error would be a random one it would not make sense to run again using --report, but in most cases an error is not random and the second run would offer a easy way to produce a complete error report / ticket. Maybe best would be to improve the logger like you suggest and on (fatal) error always ask the user if he wants to save or submit relevant environment and process info or just exit?
This will be at least partially addressed by TIMOB-12169 which will include a banner like the following in the log for every build:
Mon Nov 17 2014 11:38:32 GMT-0500 (EST) Build Environment Host OS = OS X 14.0.0, x64 Target platform = iphone CLI version = 3.5.0-dev SDK version = 3.5.0 SDK path = /Users/admin/Library/Application Support/Titanium/mobilesdk/osx/3.5.0 Node version = v0.10.33 Command = titanium --sdk 3.5.0 build -p iosThat looks good [~skypanther] - I guess that closes this ticket [~cbarber]. Although sending errors directy to some kind of inbox of JIRA would still be nice.
Fixed as apart of TIMOB-12169. There isn't an explicit
--reportflag, but a build log is a good start.Verified fixed using: Titanium CLI 4.0.0-alpha environment is included in log