You can leverage the Shipa Action published in the GitHub Actions Marketplace to trigger your Shipa related action.

You can use the example below to set an initial action:

on: [ push ]

jobs:
  shipa_action:
    runs-on: ubuntu-latest
    name: action_name
    steps:
      - name: Checkout
        uses: actions/[email protected]
      - name: Creating Framework
        uses: shipa-corp/[email protected]
        env:
          SHIPA_TOKEN: ${{ secrets.SHIPA_TOKEN }}
          SHIPA_HOST: ${{ secrets.SHIPA_HOST }}
        with:
          shipa-action: './definition.yml'

Required Environment Variables

For the Shipa GitHub Action to successfully run, you will need to set the environment variables below as part of your action:

Component	Type	Description
SHIPA_TOKEN	variable	Your Shipa token that should be used to connect to your Shipa account and perform the action You can find your Shipa token by using the following Shipa CLI command: shipa token show You can download the Shipa CLI here
SHIPA_HOST	variabler	The target URL of your Shipa instance. If you are using Shipa Cloud, your target will always be: https://target.shipa.cloud:8081

Component

Type

Description

SHIPA_TOKEN

variable

Your Shipa token that should be used to connect to your Shipa account and perform the action

You can find your Shipa token by using the following Shipa CLI command:

shipa token show

You can download the Shipa CLI here

SHIPA_HOST

variabler

The target URL of your Shipa instance.

If you are using Shipa Cloud, your target will always be:

https://target.shipa.cloud:8081

Both variables can be set as Secrets in your GitHub repository.