mikaelvesavuori / github-ci-demo

This is a basic demonstration of what is needed to run a GitHub Actions CI build by calling their REST API.

GitHub Actions CI demo through REST API

This is a basic demonstration of what is needed to run a GitHub Actions CI build by calling their REST API.

We are using Figmagic for this demo to demonstrate running it in CI. Even if you don't care for that specific tool, you'll get the gist of how to automate stuff in CI.

Instructions

Clone this repo and put it on GitHub.

Set secrets for the pipeline as per:

• FIGMA_TOKEN as your Figma API token
• FIGMA_URL to point to your Figma file ID

Authentication

The ideal way to authenticate is through Personal Access Tokens. Create one at the dedicated page for Personal Access Tokens.

A suitable access scope is repo.

Example call to API

Set the following headers:

• Accept: application/vnd.github.v3+json
• Content-Type: application/json
• Authorization: token {YOUR_PERSONAL_ACCESS_TOKEN}

Then send a payload:

POST https://api.github.com/repos/{USER_NAME}/{REPO_NAME}/actions/workflows/{WORKFLOW_FILENAME}/dispatches

{
  "ref": "main"
}

If you want to send in inputs, the format is:

{
  "ref": "main",
  "inputs": {
    "message": "No message",
    "version": "latest"
  }
}

Only inputs that the workflow expects will be allowed. If it contains anything unexpected, the call will fail.

References

• GitHub: Creating a personal access token
• GitHub: Authentication in a workflow
• GitHub: Personal access tokens
• GitHub: Getting started with the REST API
• GitHub: Create a workflow dispatch event
• GitHub: Events that trigger workflows