Vetrix Docs

Configuring a pipeline

Vetrix runs CI/CD pipelines from a configuration file you keep in your repository, named vetrix-ci.yml. This page explains how the web UI directs you to add that file, how it labels what starts each pipeline, and how to manage the write-only variables a pipeline reads while it runs. The configuration itself lives in the file you commit; the UI shows you the results and lets you manage per-branch variables.

Where to find it

  • Configuration file: the pipeline configuration lives at the root of your repository in a file named vetrix-ci.yml. You add or change it by committing to the repository.
  • Pipelines list: open a repository and select Pipelines in the left sidebar, at gitvetrix.com/<owner>/<repo>/pipelines. The Pipelines page across all your repositories is at gitvetrix.com/pipelines.
  • Pipeline variables: open a repository, select Pipelines in the left sidebar, then select Environment Configuration, at gitvetrix.com/<owner>/<repo>/pipelines/environment-configuration. The Environment Configuration entry appears only when you have permission to run CI on the repository.

Add a pipeline configuration file

  1. Create a file named vetrix-ci.yml at the root of your repository.
  2. Commit the file and push it to a branch.
  3. Open Pipelines for the repository, or the Pipelines page across your repositories. Until a pipeline has run, the page shows No pipelines yet with the guidance to push a commit to a repository with a vetrix-ci.yml file to trigger your first pipeline.
  4. After you push, the new pipeline appears in the list. Select it to follow its jobs and logs.

A repository that has never run a pipeline shows No pipelines, inviting you to push a commit or trigger a pipeline manually.

Understand what triggers a pipeline

Every pipeline in the list shows what started it, so you can confirm your configuration runs when you expect. Vetrix labels each run by its trigger:

  • Push — started by a push to a branch or tag. The pipeline reads Triggered by push to that branch or tag.
  • Manual — started by hand. The pipeline reads Triggered manually.
  • Scheduled — started on a schedule. The pipeline reads Triggered by schedule.
  • API — started through the API. The pipeline reads Triggered via API.

To narrow a repository's list to one kind of run, use the Filter by trigger control. It offers All triggers, Push, Manual, and Schedule. Use the Filter by branch / tag field beside it to limit the list to a single reference.

Add a pipeline variable

Pipeline variables are name-and-value pairs your jobs read from their environment. Values are write-only: once you save a variable, Vetrix never displays its value again. Variables are stored per branch.

  1. Open Environment Configuration for the repository.
  2. In the Branch field, enter the branch whose variables you want to manage. Until you enter a branch, the page shows Select a branch.
  3. Select Add variable.
  4. Enter a Name. Use letters, digits, and underscores; the name cannot start with a digit.
  5. Enter a Value. The value is write-only and is not shown again after you save it.
  6. Optionally select Show value in job logs to let the value appear in plaintext in job logs. Leave it unselected to keep the value redacted from logs. Either way, the value stays encrypted at rest.
  7. Select Add variable.

The variable appears in the table with its Name, who created it under Created by, and its Created date. A variable set to appear in logs carries a Viewable in logs badge. A branch with no variables shows No variables.

Rotate a variable's value

  1. Find the variable in the table and select Edit.
  2. In Rotate value, enter a New value. Leave it blank to keep the current value unchanged.
  3. Optionally change Show value in job logs.
  4. Select Rotate value.

Delete a variable

  1. Find the variable in the table and select Delete.
  2. In the Delete variable dialog, confirm the deletion. Deleting the variable removes it from that branch, and pipelines on the branch no longer receive it.
  3. Select the confirm button to delete the variable.

Tips

  • Variable names follow shell environment-variable rules: start with a letter or underscore, then use letters, digits, or underscores.
  • Variables are scoped to a single branch. Set the same variable on each branch whose pipelines need it.
  • Keep secrets out of logs: leave Show value in job logs unselected unless the value is safe to print.