YAML Documentation Tasks YAML

YAML Documentation Generator

The 'YAML Documentation Generator' package contains the following tasks. The table show the possible variables that can be used in YAML Azure DevOps Pipeline configurations

GenerateYAMLTask V2

Generate YAML documentation for the Azure DevOps Extension

YAML snippet

# Generate YAML Documentation
# Description - Generate YAML documentation for the Azure DevOps Extension
- task: GenerateYAMLTask@2
  inputs: 
     # Required arguments
     inDir: $(System.DefaultWorkingDirectory)
     outDir: $(Build.ArtifactStagingDirectory)

Arguments

• Argument: inDir
  • Description: The directory that contains the 'vss-extensionjson' for the extension
  • Type: string
  • Required: true
  • Default (if defined): $(System.DefaultWorkingDirectory)
• Argument: outDir
  • Description: The folder to write the documentation to.
  • Type: string
  • Required: true
  • Default (if defined): $(Build.ArtifactStagingDirectory)

Advanced

• Argument: filePrefix
  • Description: Prefix for filename, if not set the -YAML.md will be used
  • Type: string
  • Required: false
  • Default (if defined):
• Argument: copyReadme
  • Description: If true also copies the extension readme.md as .md
  • Type: boolean
  • Required: false
  • Default (if defined): False