GitHub Adapter

Connect to Transmute VDP from Github with ease by leveraging the GitHub Adapter

This page will cover how to install the GitHub Adapter from the Transmute Adapter marketplace which you can find here.

The adapter uses an open source template repository to connection to the Verifiable Data Platform with OAuth authentication. The repository can be found here: https://github.com/transmute-industries/template-adapter-github

Installing the Adapter

This section will cover getting up and running with the GitHub adapter, which allows you to issue a credential from a GitHub workflow.

Mavigating to the GitHub Adapter

This will take you to the details page for the adapter. Click on the the Install button. Your browser will automatically download a Github Adapter.zip file.

Github Adapter detail page

You will be shown a modal indicating the application has been created on the Verifiable Data Platform. Clicking on Uh, Okay? will close the modal. Clicking on Let's Go! will bring you to this documentation.

Adapter install confirmation modal

The next steps will require running commands on the command line. In Windows this means moving the downloaded Github Adapter.zip file to the Ubuntu file-system. You will also nee do the Github CLI tool gh installed. You can find instructions for how to install here: https://cli.github.com/manual/installation. You will also need to be logged in with the gh tool, instructions for how to do that can be found here: https://docs.github.com/en/github-cli/github-cli/quickstart.

Running the script

Once these steps are complete, you can run the following commands to create a repository that holds the adapter. Note the $ character is to show a command and not the be included in the line to execute.

$ unzip Github\ Adapter.zip

This will extract a script.sh and .env file from the zip.

$ chmod +x script.sh
$ ./script.sh

Running the Action

This will create a new private repository under you Github account named my-project, which is pre-populated with the settings to be able to run a workflow to issue a credential calling the Verifiable Data Platform API. The script will end with opening the browser to the location of this repository.

Adapter repository

To run the action to issue a credential, click on the Actions tab on the top of the repository.

Dispatch action

On the actions page, click on the Issue Credential list item, then click the Run workflow dropdown. And click on the Run workflow button to trigger the action to issue the credential.

Issue credential action in progress

This will initialize a new action that will have a yellow spinning icon to indicate the workflow is running. Once the action is complete you should see the spinning yellow icon turn into a green check-mark.

Issue credential action complete

Click on the Issue Credential text to see the details about the action that was run.

Issue Credential artifact

You can click on the issued-verifiable-credential artifact in order to download the credential that you issued. And example of what this should look like is displayed below.

{
  "@context": "https://www.w3.org/2018/credentials/v1",
  "type": [
    "VerifiableCredential"
  ],
  "issuer": "did:web:test.transmute.industries:organizations:org_pmybE9LVkDde9Jh7",
  "issuanceDate": "2023-01-10T14:49:39Z",
  "credentialSubject": {
    "id": "did:example:456"
  },
  "proof": {
    "type": "Ed25519Signature2018",
    "created": "2023-01-10T14:49:40Z",
    "verificationMethod": "did:web:test.transmute.industries:organizations:org_pmybE9LVkDde9Jh7#z6MkfJwuJniojSD6XmeQ3V9xkkaw6EZp53BnnMMUrQNxAGRM",
    "proofPurpose": "assertionMethod",
    "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..IOyALSto5FQwa8HUxM2e8dYrT8rQG__v0rT4hxCnPTaXMRSFL8DGWbo0q3kcemP20US9e4V80zlXqsttl9ezBg"
  }
}

If you want to verify that your credential was issued, you can navigate to your list of credentials in the application to see the credential populated there.

Credential Issued

Issued credential in application

Congratulations on issuing your first credential with a workflow. See what other functionality we can help you unlock with GitHub workflows.