Hello World Example

Now you have created an account, you can get started with the basics of BeetleboxCI by getting a pipeline to print Hello World.

Creating our git repo

Before you can create a pipeline, you need to create a code repository that will form the code base of the pipeline:

1. Create a new folder called .bbx in a Github code repository.
2. Create a file called config.yaml in the folder you just created and copy in the following code:

runners:
 local-runner:
  image: public.ecr.aws/y2s4f3y9/ubuntu-generic:latest
jobs:   
 hello-world:
  resource_spec: micro
  runner: local-runner
  current_working_directory: ~/
  steps:
   - run:
      name: Say Hello World
      command: echo "Hello World" 
      
workflows:
 hello-world-workflow:
  jobs:
   - hello-world

Create your first pipeline

Now you have created your code repository, it is time to link it to your first pipeline. In your BeetleboxCI account, you will be greeted by the following screen:

To make your first pipeline please perform the following steps:

1. Click 'Create pipeline'
2. In the following screen, fill in the following:

• Pipeline Name: hello-world

• Repository URL: https://github.com/<username>/<repo_name>

• Authentication Settings — Username: <The name of your git account>

• Authentication Settings — Password: <Github personal access token>

  If you created your repository with public access, then the authentication information will not be necessary. Note that Github no longer supports password authentication for cloning repositories, so a personal access token is required. If you do not already have a personal access token for Github, you can follow this link from Github which shows how to create one.

  As an alternative to your username and a personal access token, you can generate an SSH key to authenticate access to private git repositories (given that the public key is added either to your Github account or just as a deploy key to the repository). More information on this can be found in the VCS Integration section.

3. Click proceed. You will now be redirected to the pipelines page where you can see the pipeline that you just created.
4. On the pipelines page, click hello-world so see the workflows in this pipeline
5. Click the run button on the top right hand corner of the workflows list. The pipeline will begin running and it should take around 30 seconds to complete.
6. You will see "Passed" on the hello-world pipeline once it has completed.

Viewing our output

7. You can also check our logs to make sure the output is correct. To do this, click on the pipeline name hello-world.

8. In this page you will be able to view the workflows of the hello-world pipeline. There will be a single workflow named hello-world-workflow, which will take us to the jobs that make up that workflow.

9. In the jobs page, you may view the jobs that are used in the hello-world-workflow. Click on the job name hello-world

10. From here, you will be able to view details about the job, including an overview of its status as well as logs and artifacts generated by this job.

11. By checking out the Log, you can see the generated logs by the job. In this case, you will be able to see that the job has successfully outputted the Hello World message.

Congratulations you have run your first pipeline!

What's next?

• Explore BeetleboxCI concepts
• Getting Started with BeetleboxCI and Vivado
• Getting Started with BeetleboxCI and Vitis