/xlr-github-actions-plugin

A plugin to orchestrate and visualize GitHub Actions workflows from Release.

Primary LanguagePythonMIT LicenseMIT

GitHub Actions Integration for XL Release

Build Status GitHub release License: MIT Github All Releases standard-readme compliant

Installation

Requirements

  1. XL Release 9.0+

Building the plugin

The gradle wrapper facilitates building the plugin. Use the following command to build using Gradle:

./gradlew clean build

The built plugin, along with other files from the build, can then be found in the build folder.

Adding the plugin to XL Release

Download the latest version of the plugin from the releases page. The plugin can then be installed through the XL Release graphical interface or the server backend. For additional detail, please refer to the docs.xebialabs.com documentation on XLR plugin installation

Usage

Available Tasks: Check Workflow Run, Trigger Workflow Run

Available Triggers: None

Available Dashboard Tiles: Workflow Runs Timeline Tile

Tasks

Check Workflow Run

Properties:

  • Server input
  • Owner input
  • Repository input
  • Workflow ID input
  • Run Id Script script
  • Workflow Run ID output

Trigger Workflow Run

Properties:

  • Server input
  • Owner input
  • Repository input
  • Workflow ID input
  • Ref input
    • The reference of the workflow run. The reference can be a branch, tag, or a commit SHA.
  • Inputs input
    • Comma-separated keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.
  • Triggered script
  • Run Id Script script
  • Workflow Run ID output

Tiles

Workflow Runs Timeline Tile

Properties:

  • Server input
  • Title
    • Tile title
  • Owner input
  • Repository input
  • Workflow ID input
  • Count input
    • The number of latest workflow runs to visualize

workflow runs timeline tile

Contributing

Please review the contributing guidelines for xebialabs-community at http://xebialabs-community.github.io/

License

This community plugin is licensed under the MIT license.

See license in LICENSE.md