Integrating with Git

This section will help you understand Kyso's Git integration so you can start automatically publishing reports on commit.

Kyso integrates with all 3 Git systems:

GithubGitlabBitbucket

How does it work?

Kyso uses Git actions & CI pipelines with each VCS. This is a super-powered way of integrating into your existing workflows, allowing you to fine tune how you commit your work to Kyso - you can choose to integrate a specific branch, tag, on an event - or any other specification of your choosing. You can import both public and private repositories from Git.

Git metadata capture

When you create a report on Kyso, in the browser or from the Command Line, report metadata is created automatically. This is so users can browse through previous iterations of a project and track where & when changes are made, and by whom.

For Git–based reports, we've updated the report interface to also display the commit hash and provide links back to the source Git repository.

No additional action nor configuration is needed from the user. Simply integrate the Kyso CLI into your Git CI pipelines (see our docs on how to do that here), and Kyso will handle the rest.

This is how a Git-based report now looks on Kyso:

Git Links

Report Version & Commit Hash

In the image on the left you can see both the link back to the main Git repository and to the specific commit hash of that report version. On the right, users can browse through previous iterations of the project on Kyso, with each version displaying it's own Git metadata, such as commit hash & creation date.

Kyso Metadata Configuration

Remember that in order to ensure a successful import process, your repositories will need to be set up so Kyso can read in the metadata and properly structure your content. This is especially important if you're connecting multiple repositories or one repository with a lot of sub-directories intended to be published as their own individual Kyso reports. Read more about report metadata here:

Configuring Report Metadata