search

sirlilpanda / kicad-project-template

a simple template for creating PCB with ci/cd for create docs
1 stars 0 forks source link

Support for revision-centric workflows #8

Open JHay0112 opened 3 weeks ago

JHay0112 commented 3 weeks ago

I'd like to support a different workflow for PCB design than the current one. My understanding of the current one is that updates are made to the supporting documentation for every push on the mainline. This is different to my own ideal workflow, what I would prefer is:

  1. ERC/DRC checks are run on every push, reported as an action pass or fail, and the results stored as an action artefact.
  2. Gerber and BOM are run on every release and included as a part of the release package.

@sirlilpanda do you think it's possible that we could tweak the project template to permit for such a variation, or is this something else completely?

sirlilpanda commented 3 weeks ago

It is possible to have Gerber and BOM run on release, it would require some reworking but doable. although the counter point to this is, no one does release of their personal projects and would therefor never run. instead i suggest these could run on a merge in to main, but i know people will just push in to main for these projects and expect to re-run these.

I am conflicted with uploading ERC and DRC as artifacts because they are normally a pain in the ass to find. Although they are arguably the right solution for this problem. this is in addition to the main reason they are in markdown files now is so they can be displayed on github and you dont have download an artifact to the warns and errors.

JHay0112 commented 2 weeks ago

Artefacts totally are a pain to find. It would be nice if GitHub had a better solution for showing them as apart of action runs but alas, that's largely out of our control. Might be nice to setup the workflow to push them to the repo with the support to ammend per #4.

I'd still be keen on having the support for a revision centric workflow since I think it's both a good habit to encourage (sure "no-one" ever releases but if you are getting something manufactured then it probably makes sense to). Probably not a priority till we can nail #9