This Github action is an official Relisio deploy utility.
Use it to create products within your workspace.

Prerequisites

1. an active workspace at www.relisio.com or a self-hosted copy of Relisio;
2. an api-key authorized to Create Product (in Relisio, go to workspace settings, Api Keys to generate one);
3. a GitHub repository configured to run Actions;

Before you start

1. consider that Relisio is currently in Beta, and breaking changes may occur at any time,
2. the api-key can be generated (and destroyed) from your workspace settings,
3. optionally you may use this action together with
   • Studio-41/relisio-artefact-action@v1
   • Studio-41/relisio-project-action@v1

Available inputs

id	description	required	default
relisio-url	Relisio base url (only for self-hosted or enterprise installations)	false	https://relisio.com
api-key	API key to authorize the deployment	true
workspace-path	Path of the Workspace where to publish the Product	true
product-template-id	ID of an existing product withing the workspace to clone as the base for this new product	false
product-name	Name of the product. Required if product-template-id is not defined. When product-template-id is specified, Relisio will use the original name	conditional
product-scope	Visibility of the product withing the workspace (private, internal or public)	true	internal

Available outputs

id	description
product-id	The string representing the new product ID
api-url	The URL pointing to the new product
public-url	The public URL of the product (visible depending on the selected scope)

Deploy a new product

The following example publishes a new product into your workspace every time a Tag (having v prefix) is created.

• An empty product will be created as the product-template-id isn't specified.
• The product will be created inside the Workspace workspace-path.
• As the visibility is internal, the product will be visible by the users at the workspace only.

on:
  push:
    tags:
      - "v*"

jobs:
  deloy:
    runs-on: ubuntu-latest
    steps:
    - name: Deploy As Relisio Product 
      uses: Studio-41/relisio-product-action@v1
      with:
        api-key: ${{ secrets.RELISIO_API_KEY }}
        workspace-path: ${{ secrets.RELISIO_WORKSPACE }}
        product-scope: internal
        product-name: The Name of The Product

Deploy a new product (cloning a template)

The following example publishes a new product, cloning an existing one, into your workspace.

• A new product will be created cloning the product product-template-id.
• The product will be created inside the Workspace workspace-path.
• As the visibility is public, the product will be visible by the Internet (if you are running a self-hosted version of Relisio, public is may be limited by your networking policies).

on:
  push:
    tags:
      - "v*"

jobs:
  deloy:
    runs-on: ubuntu-latest
    steps:
    - name: Deploy As Relisio Product 
      uses: Studio-41/relisio-product-action@v1
      with:
        api-key: ${{ secrets.RELISIO_API_KEY }}
        workspace-path: ${{ secrets.RELISIO_WORKSPACE }}
        product-scope: public
        product-template-id: ${{ secrets.RELISIO_PRODUCT_TEMPLATE_ID }}

---

Work with Relisio Artefacts

You can optionally configure your GitHub Workflow to upload any artefact as part of the new product using Studio-41/relisio-artefact-action@v1 (more details).

Work with Relisio Projects

If you want to publish this product as part of a new Release for a specific Relisio Environment, you can combine this action with Studio-41/relisio-project-action@v1 (more details).

---

Professional support is available

Relisio is a Studio 41 Software Design S.L. product.

Enterprise service is available for organizations wanting to implement Relisio into their current CI pipeline.

Contact us at info@41.studio. We will do our best to assist you with Relisio related automation or queries.