👋 Hello logsight.ai from GitHub Actions

Continuous Verification and Testing are important phases of software delivery. This repo described how logsight.ai can be used to add Quality Gates to a CI/CD pipeline build with GitHub Actions.

We use the Stage Verifier service from logsight.ai since it enables to analyze and compare log files generated by differente versions of an application.

Use Case

• You are collaborating on changes to a repository using your own branch
• You create a pull request to propose a new feature
• Before merging the changes, the CI/CD triggers a continuous verification gate

• Logsight Stage Verifier analyzes the logs generated by the two applications / branches
• The deployment risk score is ⚠️ 78%
• Since the risk is high, the merge is automatically cancelled and a GitHub Issue is created

For the impatient

To try the simplicity and transparency of using Logsight, we recommend you to follow the instructions directly from our Hello Logsight tutorial

1. Fork the hello-logsight repository

2. Go to Pull Requests and create a New pull request

3. In the compare drop-down list, set compare: candidate

4. Create pull request

5. The continuous verification gate runs

6. If the verification fails:bangbang:, a report is created with the deployment risk. The report is available under GitHub Issues.

7. In the detailed report you will see the log lines that are probable cause for the problem. You can fix the problem with the candidate branch:
   1. Set HEARTBEAT=True in the hello_logsight.py in your forked repository
   2. Commit and check your already open pull request. The quality check will run again and this time will pass
   3. If you wish, you can open hello_logsight.py and understand where it was failing

Github Report

The following image gives an example of a report created by the CI/CD Stage Verifier gate:

Logsight.ai Report

You can also view a more detailed report of the verification using the online service. You need to have a logsight.ai user account.

To access the report, select the Detailed onine report link shown in the Github Report.

👋 Goodbye

The hello-logsight example ends here. You can get more in-depth knowledge about the actions and how to use them at docs.logsight.ai