workflows.md

Workflows

!! UNDER CONSTRUCTION !!

Table of Contents

• Introduction
• CommonAPI Code Generator Workflow

Introduction

GitHub Actions is a feature provided by GitHub that allows you to automate, customize, and execute your software development workflows right in your repository. You can think of it as a CI/CD (Continuous Integration/Continuous Deployment) tool that is integrated directly into GitHub.

With GitHub Actions, you can create workflows that respond to various GitHub events such as pushing code, creating pull requests, or raising issues. These workflows are composed of one or more jobs, and each job consists of a series of steps that perform individual tasks. Steps can run commands, run setup tasks, or run an action in your repository.

GitHub Actions supports workflows that run on Linux, Windows, and macOS virtual machines, and also provides a rich marketplace of pre-built actions that you can use in your workflows.

In the context of your document, it seems like GitHub Actions is being used to automatically generate code when changes are pushed to the repository. This is a common use case for GitHub Actions, as it can help to ensure that your generated code is always up-to-date with your source code.

CommonAPI Code Generator Workflow

To use the convesa's commonAPI auto generated code is required.
The code can be generated by using the github action workflows that are defined in the .github/workflows folder.

• 1. Modify the .fidl or .fdepl file, than commit and push to remote reposity.
     

git add .
git commit -m "fidl file changed"
git push

The github workflow will generate the code and push it in the folder "src-gen".
After the code is generated, pull from remote repository.

git pull

• 2. Build Service and Client applications
     

./scripts/Build.sh

• 3. Run Application (Sercive & Client) Run to start vSOME/IP service and client application in split terminal.
     

./scripts/Run_Services.sh

./scripts/Run_Client.sh

---

References

Github Actions capixx-tools-CI-CD