Using Git-based Webapps

Understanding Git-based Workflows for Webapps

Aidan Chiu avatar
Written by Aidan Chiu
Updated over a week ago

TelemetryTV is excited to introduce our new Git-based Webapps feature. For those who are unfamiliar with the terminology, here are some quick definitions:

Definitions

  • Git: a popular version control system that allows developers to keep track of changes made to their code over time.

  • GitHub: a web-based platform where developers can host their code repositories and collaborate with others.

  • GitHub Actions: a tool that allows developers to automate tasks within their GitHub repositories, such as building and deploying their code.

  • Build container: a lightweight, standalone environment that contains all the necessary tools and dependencies to build and run an application.

  • Build command: a set of instructions that tells a build system how to compile and package an application.

  • Build directory: a directory that contains the source code and any necessary files to build an application.

  • Publish directory: a directory that contains the compiled and packaged version of an application ready for deployment.

Now, back to our new feature. Git-based Webapps allow TelemetryTV users to deploy web applications using their own devops enabled workflows, pulling from Git repositories like GitHub.

Here's how it works:

  1. A web application, assembled by a Javascript runtime, is hosted in a Git repository on GitHub (or any other Git hosting platform).

  2. To have the TelemetryTV Webapp look like the latest version of the web application in GitHub, developers can add a separate step in a GitHub workflow file or have a separate webhook.

  3. When TelemetryTV receives an HTTP request, it rebuilds the Webapp using the build command within a build container. This process takes place in the build directory.

  4. Once the Webapp has been rebuilt, TelemetryTV deploys it to the publish directory, where it is ready to be displayed on assigned devices.

  5. Updates to the Webapp can be automatically deployed through tools like GitHub Actions or Bitbucket, making for fast and easy iterations.

  6. TelemetryTV also supports testing environments through multiple branch support, so developers can test changes before deploying them to production.

It's important to note that there is a limit to the amount of build time that can be used by TelemetryTV - currently 1000 builds per month. Additionally, builds can only be triggered once per hour.

Using the Git-based Webapps Feature

  1. Navigate to Webapps on the left hand side of your administrative interface.

2. Select Create

3. Add your Git repository URL to the "Git URL" field.

4. Configure the remaining fields of your Webapp.

5. Click Save

TelemetryTV will automatically deploy updates through tools like GitHub Actions and Bitbucket directly to your assigned devices.

Did this answer your question?