Skip to content

Link a Git Repository to the EmbedOps Platform

Prerequisites

  • You are an admin on the EmbedOps platform.

How do you know if you are an admin

Click on your profile drop-down on the top right corner of the EmbedOps platform. If you are an admin, you will have the "Administration" button.

Steps

  1. Create or fork a Git repository on a source control platform such as GitLab or GitHub.

  2. Clone the Git repository to your local machine.

  3. Run eo init in the root of the Git repository. This will create a repository on the EmbedOps platform.

  4. Run eo open to open the EmbedOps platform in a browser.

  5. Retrieve the Repo API key.

    1. Click on the "Administration" button under the profile drop-down on the top right corner of the EmbedOps platform.

    2. Click on "Manage Organizations" and select the organization where the repository you just created is under.

    3. Under the "Projects" section, click on the project where your repository is under, and then click on the repository name.

    4. Under the "API Keys" section, you will find the Repo API key.

  6. Create a CI/CD variable or secret on the source control platform.

    1. On GitLab, go to the repository's "Settings" -> CI/CD -> Variables -> Project variables -> Add variable.

    2. On GitHub, go to the repository's "Settings" -> Secrets and variables -> Actions -> Repository secrets -> New repository secret.

    3. Copy the Repo API key that you found on step 5 and add it as EMBEDOPS_API_REPO_KEY.

    Warning

    GitLab only: Uncheck the "Protect variable" flag if you are not planning to run the CI/CD pipelines on protected branches or tags.

  7. Uncomment the eo report lines in the shell scripts under ci/ directory. The following is an example of the commented lines:

    # set +e
# EMBEDOPS_COMPILER=GCC eo report memusage build.log
# set -e

    Warning

    GitHub only: Uncomment the env: sections in the .github/workflows/*.yml.

  8. Commit and push the changes to the source control platform. This action will trigger CI pipelines. When the CI pipeline finishes running, the reports will appear on the EmbedOps platform. The Git repository is officially connected to the EmbedOps platform!