https://github.com/sguter90/directus-extension-woodpecker-build-status

A visual woodpecker build status indicator for directus
https://github.com/sguter90/directus-extension-woodpecker-build-status

Last synced: about 2 months ago
JSON representation

A visual woodpecker build status indicator for directus

• Host: GitHub
• URL: https://github.com/sguter90/directus-extension-woodpecker-build-status
• Owner: sguter90
• Created: 2023-05-07T14:57:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-08T10:46:16.000Z (over 1 year ago)
• Last Synced: 2024-01-25T00:13:29.721Z (12 months ago)
• Language: TypeScript
• Size: 415 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-directus - Woodpecker Build Status - Adds status bar for [Woodpecker](https://woodpecker-ci.org/) pipeline build status to Directus UI. (Extensions / Community)

README

        
# Directus Woodpecker build status

An extension for [Directus](https://github.com/directus/directus) which adds a visual loader line to provide a visual feedback of current [Woodpecker](https://github.com/woodpecker-ci/woodpecker) build pipeline status.

## How it works

The woodpecker badge API is used to fetch the current pipeline status.

This results in 3 states which are represented in a small status bar:

* **success**: last build was successful (primary colored bar + fade out animation)

* **in-progress**: pipeline is currently running (primary colored bar + loading animation)

* **failed**: last build failed (red colored bar + blink animation)

![Loading bar demo](doc/demo.gif)

## Installation

```shell

npm install directus-extension-woodpecker-build-status

```

## Configuration

### Build pipeline status URL

URL can be set per directus instance via environment variable with the following schema:    

``https://woodpecker.example.com/api/badges///cc.xml?branch=``  

Example:

```shell

WOODPECKER_BUILD_STATUS_URL="https://woodpecker.myserver.com/api/badges/myorg/myrepo/cc.xml?branch=main"

```

### Bar colors

Colors used in the bar are configured via default directus CSS variables.

For more information about directus CSS variables see official [directus docs](https://docs.directus.io/extensions/themes.html#project-styling).

| Status      | CSS variable |

|-------------|--------------|

| success     | --primary    |

| in-progress | --primary    |

| failed      | --danger     |