How to Use Itential GitHub Actions

Follow the instructions below to successfully use Itential GitHub Actions.

Step 1

Create two directories in your GitHub project repository

cd project-name
mkdir .github
cd .github
mkdir workflows
cd workflows

Step 2

Create a new workflow file inside the workflow directory

cd workflows
touch trigger_service.yml 

Step 3

Search for the Itential Action on GitHub Marketplace. Once you find the Action, make sure to click the "Use the Latest Version" option. Then, click the clipboard icon to copy the provided data.

Figure 1: GitHub Marketplace Search

Step 4

To make use of the Itential GitHub Actions, paste the content to the new workflow file you made inside of workflow directory.

Note: The example below uses metadata provided when using the Itential Automation Start Action.

# This is a basic workflow to help you get started with Actions
name: Start automation on pull request
# Controls when the workflow will run
on:
  pull_request:
    types: [opened]

jobs:
  job1:
    runs-on: ubuntu-latest
    outputs:
      #step1 output
      output1: ${{ steps.step1.outputs.results }}
    name: Automation start
    steps:
      # To use this repository's private action, you must checkout the repository
      - name: Checkout
        uses: actions/checkout@v3
      - name: Itential Automation Start action step
        id: step1
        uses: itential/itential-automation-start@replace_with_latest_version
        with:
          #github_token: ${{secrets.GITHUB_TOKEN}} # include only if user requires a GitHub Token
          itential_host_url: ${{secrets.ITENTIAL_HOST_URL}}
          auth_token: ${{secrets.AUTH_TOKEN}}
          auth_username: ${{secrets.AUTH_USERNAME}}
          auth_password: ${{secrets.AUTH_PASSWORD}}
          auth_client_id: ${{secrets.AUTH_CLIENT_ID}}
          auth_client_secret: ${{secrets.AUTH_CLIENT_SECRET}}
          time_interval: 1
          no_of_attempts: 200
          api_endpoint: ${{secrets.API_ENDPOINT}}
          api_endpoint_body: ${{secrets.API_ENDPOINT_BODY}}
          automation_status: 1
      - name: Get output
        run: echo "${{steps.step1.outputs.results}}"

Step 5

Execute the workflow from GitHub**
Save the necessary variables as secrets inside GitHub : IAP_INSTANCE, IAP_TOKEN and IAP_ENDPOINT. For more information on GitHub Secrets

• Click the “Actions” tab

• Click the “Provision Itential Service” workflow name and then click “Run Workflow”

• Click on “Run workflow” button

The workflow will trigger a service in Itential Automation Platform and it will also return the status of the job.