Concourse Pipeline and Task Editor for Visual Studio Code

This extension provides validation, content assist and documentation hovers for editing Concourse Pipeline and Task configuration files.

Usage

The Concourse editor automatically activates when the name of the .yml file you are editing follows a certain pattern:

• **/*pipeline*.yml | **/pipeline/*.yml | **/*pipeline*.yaml | **/pipeline/*.yaml: activates support for editing pipelines
• **/ci/**/tasks/*.yml | **/*task.yml | **/ci/**/tasks/*.yaml | **/*task.yaml : activates support for editing tasks.

You can also define your own patterns and map them to the language-ids concourse-pipeline-yaml or concourse-task-yaml by defining files.associations in workspace settings. See vscode documentation for details.

Functionality

Validation

As you type the text is parsed and checked for basic syntactic and structural correctness. Hover over an error marker to see an explanation:

Content assist

Having trouble remembering all the names of the attributes, and their spelling? Or can't remember which resource properties to set in the get task params versus its source attributes? Or don't remember what 'special' values are acceptable for a certain property? Content assist to the rescue:

Documentation Hovers

Having trouble remembering exactly what the meaning of each attribute is? Hover over an attribute and read its detailed documentation:

Goto Symbol in File

Is your Pipeline yaml file getting larger and is it becoming harder to find a particular Job, Resource or Resource Type declaration? The "Goto Symbol in File" command helps you quickly jump to a specific definition.

Type CTRL-SHIFT-O to popup a list of all symbols in your current Pipeline file. Start typing a name (or portion thereof) to narrow down the list. Select a symbol to jump directly to its location in the file.

Goto/Peek Definition

Use "Goto Defition" or "Peek Definition" to quickly go (or peek) from a a Job- or Resource name to its corresponding definition.

Limitations

This Vscode Extension is still a work in progress. At the moment only a select few of the built-in resource-types have been fully defined in the Editor's Schema.

The resource-types that are already defined in the schema are:

• git
• docker-image
• s3
• pool
• semver
• time

For other resource-types content assist and checking is still very limited. We intend to grow this list and provide a similar level of support for all of the built-in resource types in the near future.

Issues and Feature Requests

Please report bugs, issues and feature requests on the Github STS4 issue tracker.

Version: 1.56.0-PRE-RELEASE