Linking to GitHub

[#1]

This article describes how to create a secure link between your GitHub account and your iQ Tag Management account using an access token. Once linked, use the Advanced JavaScript Code extension to reference and synchronize files from a GitHub repository. Your code remains safely stored in GitHub, but is available to publish in your iQ configuration.

In this article:

• Prerequisites
• How It Works
• Supported Features
• Link a GitHub Account
• Personal Access Tokens and Repo Scope
• Unlink a GitHub Account
• FAQ

Prerequisites

• A GitHub account with at least one public repository.
• A GitHub personal access token.
• Working knowledge of GitHub and experience working with GitHub repositories.
• The Manage Account permission in your Tealium account.

How It Works

The GitHub integration creates a seamless workflow between your code management process in GitHub and publishing in iQ Tag Management. Use your GitHub username and personal access token to create a link to your GitHub account. Only one link is needed for all the profiles in your Tealium account.

Your GitHub account must have at least one public repository for the link to succeed.

Once the account is linked, the JavaScript files in your respositories are available to be referenced in your iQ Tag Management configuration. When a file from your GitHub repository is referenced it remains safely in your GitHub repository, but the code is now available to publish as part of your iQ Tag Management configuration.

As you commit changes to the referenced files in your GitHub repository, you must synchronize those files in iQ Tag Management to get the latest versions. When you synchronize the referenced files you will have unsaved changes that must be saved and published.

Supported Features

The following features support the GitHub integration:

• Advanced JavaScript Code extension

Link a GitHub Account

To link your GitHub account, you need your GitHub username and a personal access token. Linking your GItHub account creates a secure connection to your iQ Tag Management account that allows repository files to be referenced in your iQ Tag Management configuration.

For the link to succeed your GitHub account must have at least one public repository.

Personal Access Tokens and Repo Scope

You must have a personal access token to link your GitHub account. This token is used instead of a password to create a more secure connection. When you create a personal access token in GitHub you define the scope of access for the token. If you want to reference files from a private repository you must select the repo scope when you create your access token.

To link to your GitHub account:

1. In iQ Tag Management, go to the account admin menu and select Manage GitHub Account.
2. Enter your GitHub Username.
   This is the username or email address you use to sign in to GitHub.
3. Enter your Access Token.
   This is the token used to authenticate your account with third-party applications.
   

   Locate your access token in GitHub by going to User > Settings > Developer Settings > Personal Access Tokens.

4. Click Link Account.
   
5. Click Save Changes.

Unlink a GitHub Account

Remove access to the GitHub account by unlinking it. When you unlink the GitHub account, any files referenced in your configuration will remain, but they can no longer be synchronized.

To unlink to your GitHub account:

1. In iQ Tag Management, go to the account admin menu and select Manage GitHub Account.
2. Click Unlink Account.

FAQ

I am getting a message that says my authorization is invalid, what can I do?
This can be caused when automatic or manual syncing fails due to one of the following reasons:

• GitHub is down.
• The URL being used to retrieve the file no longer is valid. For example, the file was renamed or deleted on GitHub.
• There are too many snippets trying to be synced (more than 10).
• The personal access token was revoked or the GitHub account was deleted.

How can I correct invalid authorization errors?

• If GitHub is down, there is nothing you can do until the service is up again. You can keep using the extension as normal but will not be able to get the latest code from GitHub. If this is the case, a message with a timestamp will display that the system is unable to connect until GitHub is back up.
• If the URL being used to retrieve the file is no longer valid, you can delete the snippet if it is no longer needed and replace it with a new snippet containing the new URL.
• If you have more than ten (10) GitHub snippets that were configured to automatically sync, delete the extra snippets if possible.
• If the credentials are invalid, contact your GitHub account manager or contact GitHub support. In some cases, support may might need to unlink your account and relink it with a new access token.

What happens to referenced files in my configuration if I unlink my GitHub account?

• If you unlink your GitHub account, the referenced files remain unchanged in your configuration, but are now disconnected from the GitHub repository and can no longer be synchronized.
• If the account is unlinked, then linked again, the referenced files reconnect to the repository and can be synchronized again.

If I previously enabled the GitHub integration using the Early Access program, do I need to switch to Experiments?

• If you previously accessed the GitHub Integration for JavaScript Code Extension feature using the Early Access program, we recommend that you disable the feature in Early Access and enable the feature using Experiments.