Add more detail to commands.md documentation
See original GitHub issueThe documentation located at https://github.com/Microsoft/vsts-tasks/blob/master/docs/authoring/commands.md needs more detail added to it, here are some things that I am still unsure of after trying to puzzle it out for a while
All the issues I have found mainly have been with the documentation of ##vso[task.logdetail]
- Does
parentid
need to be passed with every request or is it a write once field likename
ororder
? - What format should time be in for
starttime
andfinishtime
? If it is a format without timezone should it be local time or UTC? - What format should the GUIDs be in?
- What should we be putting in for
type
? The two examples that you show usebuild
as the value passed in, should we always pass inbuild
or are there other valid values? - What format does
progress
need to be in, can it accept decimals, can it accept commas? - Is there well defined behavior when two objects have the same value for
order
? - Examples are not actual examples:
##vso[task.logdetail id=new guid;name=project1;type=build;order=1]create new timeline record.
would fail becauseid=new guid
is not a valid value.
Issue Analytics
- State:
- Created 7 years ago
- Reactions:14
- Comments:21 (3 by maintainers)
Top Results From Across the Web
Basic writing and formatting syntax - GitHub Docs
Create sophisticated formatting for your prose and code on GitHub with simple syntax.
Read more >Basic Syntax - Markdown Guide
The Markdown elements outlined in the original design document. ... To create a heading, add number signs ( # ) in front of...
Read more >Writing Your Docs - MkDocs
Your documentation source should be written as regular Markdown files (see Writing with Markdown below), and placed in the documentation directory. By default, ......
Read more >Document command-line syntax - Google Developers
This page shows how to document command-line commands and their arguments. For more information about formatting code that appears in text, ...
Read more >md - Microsoft Learn
Recommended content · replace. Reference article for the replace command, which can replace existing or add new files to a directory. · choice....
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
This issue still exists as more-or-less as originally reported. It should not be marked as stale. The next action needs to be taken by the Azure Pipelines Task team to clarify the format and semantics here. This is not something that we, the users of Azure Pipelines, can definitively answer ourselves.
I don’t see any sort of sub-timeline information anywhere in the latest version of the Build output UX.
In the newest UX for builds, where does the output of logdetail go? Is this even relevant information any longer?