gitlabciviewer README

Warning: This is a hackathon project - we make no promises about smoothness! This will only work for A4O employees.

First time setup

Set the following settings

• gitlabciviewer.gitlabAuthToken to a Gitlab authentication token with full API permissions.
  • Go to https://git.datcon.co.uk/-/profile/personal_access_tokens and tick api. Treat this token like a password!
  • The extension will not push any changes to gitlab, but requires full api access for the /ci/lint endpoint (despite that being a read-only API!).
• gitlabciviewer.gitlabProjectPath optionally to the Path of your project in gitlab. Example: tools.core/vscode/gitlabciviewer
  • If not set, this defaults to reading qs.toml to automatically discover the gitlab project path.

Features

View fully assembled CI file

View the fully assembled (i.e. all include and .extends expanded and merged) in a side-by-side window.

Ctrl + Shift + P
Gitlab CI Viewer: View Assembled CI File

View single include file

Download and view a single include file.

Place your cursor anywhere within an include blob and run:

Ctrl + Shift + P
Gitlab CI Viewer: View Single Include

The included file will appear in a side-by-side window.

Hover to view the value of a variable

Simply hover over a variable (assumed to be ALL_IN_CAPS) and we'll try to show you its value. This will discover variables from both the CI file, and from the variables configured in the gitlab project.

NOTE You probably don't have permissions to view group-level variables, so those won't work. Sorry!

Hover to view the fully assembled definition of a job

Simply hover over the name of a job, and the fully assembled job will appear in a hover window.

View all jobs in a stage

Hover over either the stage in the stages list to view jobs in that stage - both those defined in this file, and in the includes. Or hover over the stage: <name> in any job definition to see the same!

View the tree of stages and jobs in the VScode Tree Viewer

Once the extension is installed, a tree viewer will appear in VScode's explorer pane (typically on the left <---) called "PIPELINE OVERVIEW". This will show you a tree of stages, and the jobs in those stages.

The assembled CI file

The assembled CI file is cached on disk per-workspace. Most of the features refer to this file to provide the information in a speedy manner.

You can manually generate it for the current file you are looking at (i.e. including files that are not .gitlab-ci.yml) using the Gitlab CI Viewer: View Assembled CI File command described above.

Note that is is auto-generated whenever .gitlab-ci.yml is saved, or opened. This keeps this extension working seamlessly for you, but the cached file is unique - there is no separate caching for multiple CI files in the same project. MRs welcome to fix this! :)

Contributing

If you would like to help improve this project, please do! The main extension code base is at : https://git.datcon.co.uk/tools.core/vscode/gitlab-ci-extension The underlying assembler code is at: https://git.datcon.co.uk/tools.core/gitlab-ci-assembler