Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup a ci pipeline for firmware by leoribg #285

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

leoribg
Copy link

@leoribg leoribg commented Nov 1, 2022

No description provided.

# Test the compilation on a Docker Container

We will use a docker image with Simplicity Studio to build our project on a container. This will allow us to configure GitHub Actions to use the docker image to do the same.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's include the Dockerfile source with an explanation of what goes into the image- that's a crucial part of this setup and deserves a detailed explanation!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree. The Docker image is also 6GB. Would love to understand more about what's in there and what we're tell ing people they need to put in their GitHub Action CI image.

Would also be a good chance to update the Docker file to adhere to best practices

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, but I was trying to provide the readers a "ready to build" docker image. So they can run and build the example in minutes. The image consists of a ubuntu image with Simplicity Studio and the SDKs installed. I had to install Simplicity Studio on an Ubuntu Machine and copy the installation contents to the container to generate the image. So this is not the focus of the article. But I can try to create a docker file for it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, Simplicity Studio requires login 😕 always a bit tedious when vendors do that for free toolchains.

I'd still like to have the Dockerfile detailed here; providing a pre-built one is great if someone wants to try it, but the heart of the article is about setting up such a system, rather than the actual result (eg, if someone's not using Simplicity Studio, having the Dockerfile reference is much more valuable than the pre-built image, IMO).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, understood. I will do it.

@tyhoff
Copy link
Member

tyhoff commented Nov 4, 2022

Giving this a read-though & cleanup now. Will push directly to your branch.

Copy link
Member

@tyhoff tyhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The post is a great stat! I do think I'd like to have a bit more of the technical bits in the actual article as content - screenshots aren't great UX wise, especially for beginners.

It would be cool to have your Docker image serve as a good example of one they should use for their own builds. Part of the problem with that is that's so big.

Screen Shot 2022-11-04 at 1 11 08 PM

There are 2 full SDK's in there, each with a very large .git repo. Maybe in the Dockerfile, we can delete the .git folders because it shouldn't be necessary for CI.

# Test the compilation on a Docker Container

We will use a docker image with Simplicity Studio to build our project on a container. This will allow us to configure GitHub Actions to use the docker image to do the same.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree. The Docker image is also 6GB. Would love to understand more about what's in there and what we're tell ing people they need to put in their GitHub Action CI image.

Would also be a good chance to update the Docker file to adhere to best practices

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants