Add build GH action to demos repo

[mkhansenbot]

I'm planning to put a build GH action on this (demos) repo, to ensure all PRs can build (we need this for the competition). I'd like to propose that we require all demos to contain a Dockerfile or docker-compose.yaml and a build.sh . Then I can have the CI do a find . -name build.sh and iterate through all the build scripts found. That would work with the old demos as well as the new submissions.

[franklinselva]

I would like to see the purpose of the build.sh script for each sub directory in detail. Can you please share what are the actions that will be performed from Github Action? Are you recommending to use build.sh as an build command to be run on top of docker image?

For instance, one of the demo's build script will also make sure all the pre-requisties are installed before building and running the demos. I understand this changes the purpose of build.sh and handles the overall demo related actions to build, run and clean the builds. Should we go for a dedicated shell function specific for Github Actions? or Break the script to build.sh and run.sh?

To give more insight on the current usage of the shell script, I am adding the documentation here.

[mkhansenbot]

We currently have both a build.sh and a run.sh for the demos in the docker repo, which will be moved here. For now, I'm only planning to have the action do the build. Ideally, each demo should also include a run.sh and a test.sh or something similar that allows us to test the demos (headlessly) through the CI without hard-coding any commands into the CI.

[franklinselva]

Thanks for the pointer related to the shell scripts. I almost missed it.

We currently have both a build.sh and a run.sh for the demos in the docker repo, which will be moved here. For now, I'm only planning to have the action do the build. Ideally, each demo should also include a run.sh and a test.sh or something similar that allows us to test the demos (headlessly) through the CI without hard-coding any commands into the CI.

I can see we are planning for a very sophisticated validation pipeline for the demos. Do we also plan to use a CI provider different from Github, like Self Hosted runners?

As the first stage of such pipeline, will build.sh have only the docker image build? This will still contradict what is expected from the documentation. I feel adding a test.sh / ci.sh specifically for the GitHub actions would be a better fit. This shell script should build all the ROS packages and also build the docker image related to the demos to make the CI pass. If the idea seems feasible, I can already see we don't need separate script for GitHub actions. A common script traversing through each subdirectory should take up the job.

[mkhansenbot]

The initial intent of the build.sh was to simplify building the demos for the user. By using build.sh we ensure that the script works.

[mkhansenbot]

Fixed in #37