Skip to content
This repository has been archived by the owner on Apr 5, 2022. It is now read-only.

Latest commit

 

History

History
78 lines (49 loc) · 4.05 KB

README.md

File metadata and controls

78 lines (49 loc) · 4.05 KB
Raw

Concourse CI YAML Editor for Atom

macOS Build Status Windows Build Status Dependency Status

This extension provides basic validation, content assist and hover infos for editing Concourse Pipeline and Task Configuration Files.

It is recommended to use this extension package when atom-ide-ui atom extension package is installed. Thus, reconciling (error/warning markers) and hover support is fully functional.

Usage

The Concourse editor automatically activates when the name of the file you are editing is pipeline.yml or task.yml. Alternately, you can select the grammar for your file by doing these steps:

  • Open the file, and it will most likely open with the default Atom YAML editor.
  • In the bottom-right of the editor, click on YAML.
  • This opens the Grammar Selection dialogue. Search and select Concourse-Pipeline-YAML for pipeline files, or Concourse-Task-YAML for task files.

If you find an issue please raise it here: https://github.com/spring-projects/sts4/issues

Functionality

Validation

(Requires atom-ide-ui package) As you type the file is parsed and checked for basic syntactic and structural correctness. Hover over an error marker to see an explanation.

Linting Screenshot

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:

Content Assist Screenshot

Content Assist Screenshot

Documentation Hovers

(Requires atom-ide-ui package) Having trouble remembering exactly what the meaning of each attribute is? Hover over any attribute and read its detailed documentation.

Hover Docs Screenshot

Navigate to Symbol in File

Is your Pipeline yaml file getting larger and it is becoming harder to find a particular Job, Resource or Resource Type declaration? The Atom Outline View (View -> Toggle Outline View) helps you quickly jump to a specific definition.

Outline View

Releases:

Released versions of this package can be installed directly from the Atom package installer.

There are also development snapshots available with the latest fixes and improvements from release git repository: https://github.com/spring-projects/atom-concourse

  1. Clone the release repository for Atom package if not already cloned and navigate to atom-concourse folder
  2. Run git clean -fxd - necessary to delete out of date LS JAR file and dependency packages
  3. Run git pull - get the latest changes
  4. Run npm install - Install latest dependecnies and download proper LS JAR
  5. Run apm link . - Link the package to Atom
  6. Either start Atom or Reload Window in Atom