Add CI for ayab-esp32 - Githubissues

AllYarnsAreBeautiful / ayab-hardware

Contains the schematics and layouts for the AYAB Arduino shield

Creative Commons Attribution Share Alike 4.0 International

33 stars 13 forks source link

Add CI for ayab-esp32 #34

Closed VIPQualityPost closed 4 months ago

VIPQualityPost commented 4 months ago

This adds:

On any PR involving ayab-esp32 directory, it does ERC and DRC checks and makes sure they are clean
On any PR involving ayab-esp32 directory that gets merged into main, assembly documentation is generated and saved as an artifact from the action. Unclear to me at this point the best way to keep the artifact as these have a limited life of 1 month or something. Possible to self-create another PR with [no ci] flag so that those files can get pushed into repo but I did not try to do that yet.

t0mpr1c3 commented 4 months ago

If it's a tagged version, you could upload the artifact to the release, otherwise 1 month is probably fine. I think it might be 90 days actually.

VIPQualityPost commented 4 months ago

Yea, I was thinking more on it last night, and I think that generating the artifact on each merge to main is good, and then when we actually cut a hardware release (i.e. buy boards) then we can just take the artifact and upload to a release makes sense, at least for all the production files as we should not circulate un-verified files. The only question is if we want the auto-generated schematics / layout PDFs to live as part of the repo so that you can peruse "current state" of project easily without needing to download software. This could always come in as a follow up PR with [skip ci] tag although that is a bit manual to remember to do that. Or I can add a step to the git action to open that PR immediately actually.

VIPQualityPost commented 4 months ago

OK, this should work, we just need to create a secret github token with repo access. It will open a PR from ayab-hardware/documentation into main, skipping CI to add the generated PDFs to ayab-hardware/ayab-esp32/pdf/

t0mpr1c3 commented 4 months ago

We tend not to keep other auto-generated files, but I think we should probably keep schematic pdfs and gerbers.

VIPQualityPost commented 4 months ago

Yes, I set it to only add the PDFs. The "real" production files needed to order are still kept as artifacts so they can be used in a tagged release. @dl1com can you make the secret GITHUB_TOKEN for this?

VIPQualityPost commented 4 months ago

OH, I misunderstood, the token is generated as part of the action, so it is already pre-verified. So this should be good to go.