This Github action is an official Relisio deploy utility.
Use it to upload artefacts within your resources (like products, projects, kb).

Prerequisites

1. an active workspace at www.relisio.com or a self-hosted copy of Relisio;
2. an api-key authorized to Alter Storage or Upload Artefact (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-product-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	The ID of an existing product/project within the workspace into which upload the artefact	true
resource-id	ID of an existing product withing the workspace to clone as the base for this new product	true
resource-type	The type of resource into which the artefact will upload (project, product, environment, kb)	true
artefact-scope	The visibility of the artefact once created. Despite which scope has the resource containing this artefact, it can have its visibility scope (inherit, internal or public)	true	inherit
artefact-path	The path of the file to upload	true

Available outputs

id	description
artefact-id	ID of the uploaded artefact
artefact-sha256	sha256 of the created artefact
public-url	Full path from where to download the artefact
sha256-url	Full path from where to download the corresponding sha256 of the artefact

Ensuring Data Integrity with Hash Code

Relisio will always create a corresponding .sha256 file for each artefact uploaded (via API, GitHub Action, or interface). Use this information to double-check the integrity of your published artefacts.

A recommended way to ensure integrity is to generate a .sha256 prove locally before uploading the file to Relisio and then compare both values to trust the uploaded artefact.

Update a product with the last artefact

The following example uploads the file program.exe into an existing product.

• As the resource-type is product the artefact will be associated to that existing product.
• As the visibility is inherit, the artefact will be set to use the host product.

on:
  push:
    tags:
      - "v*"

jobs:
  deloy:
    runs-on: ubuntu-latest
    steps:
    - name: Upload artefact to Relisio
      uses: Studio-41/relisio-artefact-action@v1
      with:
        api-key: ${{ secrets.RELISIO_API_KEY }}
        workspace-path: ${{ secrets.RELISIO_WORKSPACE }}
        resource-id: ${{ secrets.RELISIO_PRODUCT_A }}
        resource-type: product
        artefact-scope: inherit
        artefact-path: ./program.exe

---

Work with Relisio Product

You can optionally configure your GitHub Workflow to create product on the fly and then upload a new artefact into it Studio-41/relisio-product-action@v1 (more details).

Work with Relisio Projects

If you want to publish artefacts 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 [email protected]. We will do our best to assist you with Relisio related automation or queries.