question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add more detail to commands.md documentation

See original GitHub issue

The 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 like name or order?
  • What format should time be in for starttime and finishtime? 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 use build as the value passed in, should we always pass in build 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 because id=new guid is not a valid value.

Issue Analytics

  • State:open
  • Created 7 years ago
  • Reactions:14
  • Comments:21 (3 by maintainers)

github_iconTop GitHub Comments

3reactions
chwarrcommented, Oct 13, 2020

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.

3reactions
d3r3kkcommented, Jun 19, 2018

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?

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found