diff --git a/README.md b/README.md index 28d1b4db..38143283 100644 --- a/README.md +++ b/README.md @@ -2656,16 +2656,16 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: INTI-CMNB/KiBot@v1 + - uses: INTI-CMNB/KiBot@v2 with: - # Required - kibot config file + # Required - kibot config file config: config.kibot.yaml - # optional - prefix to output defined in config + # optional - prefix to output defined in config dir: output - # optional - schematic file - schema: '*.sch' - # optional - PCB design file - board: '*.kicad_pcb' + # optional - schematic file + schema: 'schematic.sch' + # optional - PCB design file + board: 'pcb.kicad_pcb' - name: upload results uses: actions/upload-artifact@v2 with: @@ -2673,7 +2673,23 @@ jobs: path: output ``` -A working example applied to a repo can be found [here](https://github.com/INTI-CMNB/kicad-ci-test-spora/tree/test_gh_action). +For KiCad 6 use `v2_k6` instead of `v2`. + +A working example applied to a repo can be found [here](https://github.com/INTI-CMNB/kicad-ci-test-spora/tree/test_gh_action) +([spora_main.yml](https://github.com/INTI-CMNB/kicad-ci-test-spora/blob/test_gh_action/.github/workflows/spora_main.yml)). +Another example, but using variants can be found [here](https://github.com/INTI-CMNB/kibot_variants_arduprog) +([kibot_action.yml](https://github.com/INTI-CMNB/kibot_variants_arduprog/blob/master/.github/workflows/kibot_action.yml)) + +The available options are: + +- **config**: The KiBot config file to use. Must be specified. +- **dir**: Output directory for the generated files. The current directory is used when omitted. +- **board**: Name of the PCB file. The first file that matches `*.kicad_pcb` is used when omitted. +- **schema**: Name of the schematic file. The first file that matches `*.*sch` is used when omitted. +- **skip**: Skip preflights, comma separated or *all*. Nothing is skipped when omitted. +- **variant**: Global variant to use. No variant is applied when omitted. +- **verbose**: Level of verbosity. Valid values are 0, 1, 2 or 3. Default is 0. + ## Notes about Gerber format diff --git a/docs/README.in b/docs/README.in index 524eab95..e1b902b8 100644 --- a/docs/README.in +++ b/docs/README.in @@ -1110,16 +1110,16 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: INTI-CMNB/KiBot@v1 + - uses: INTI-CMNB/KiBot@v2 with: - # Required - kibot config file + # Required - kibot config file config: config.kibot.yaml - # optional - prefix to output defined in config + # optional - prefix to output defined in config dir: output - # optional - schematic file - schema: '*.sch' - # optional - PCB design file - board: '*.kicad_pcb' + # optional - schematic file + schema: 'schematic.sch' + # optional - PCB design file + board: 'pcb.kicad_pcb' - name: upload results uses: actions/upload-artifact@v2 with: @@ -1127,7 +1127,23 @@ jobs: path: output ``` -A working example applied to a repo can be found [here](https://github.com/INTI-CMNB/kicad-ci-test-spora/tree/test_gh_action). +For KiCad 6 use `v2_k6` instead of `v2`. + +A working example applied to a repo can be found [here](https://github.com/INTI-CMNB/kicad-ci-test-spora/tree/test_gh_action) +([spora_main.yml](https://github.com/INTI-CMNB/kicad-ci-test-spora/blob/test_gh_action/.github/workflows/spora_main.yml)). +Another example, but using variants can be found [here](https://github.com/INTI-CMNB/kibot_variants_arduprog) +([kibot_action.yml](https://github.com/INTI-CMNB/kibot_variants_arduprog/blob/master/.github/workflows/kibot_action.yml)) + +The available options are: + +- **config**: The KiBot config file to use. Must be specified. +- **dir**: Output directory for the generated files. The current directory is used when omitted. +- **board**: Name of the PCB file. The first file that matches `*.kicad_pcb` is used when omitted. +- **schema**: Name of the schematic file. The first file that matches `*.*sch` is used when omitted. +- **skip**: Skip preflights, comma separated or *all*. Nothing is skipped when omitted. +- **variant**: Global variant to use. No variant is applied when omitted. +- **verbose**: Level of verbosity. Valid values are 0, 1, 2 or 3. Default is 0. + ## Notes about Gerber format