templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[DOCs] Linked the GitHub actions readme to the main docs 

- Also adjusted some small details
This commit is contained in:
Salvador E. Tropea 2023-12-20 10:38:26 -03:00
parent 97f67e5bca
commit 454557a089
2 changed files with 31 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/GITHUB-ACTIONS-README.md
View File

@ -1,40 +1,44 @@
# Guide for using KiBot with Github Actions. # Guide for using KiBot with GitHub Actions.
Author: @sethkaz
This is a guide for getting started using KiBOT with Github Actions. This is a guide for getting started using KiBot with GitHub Actions.
## Basics ## Basics
[Github Actions](https://github.com/actions) is a CI system that runs on Github. It uses [YAML files](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html) to define what actions it will take. Unfortunately, some of the links between YAML lines and their associated actions are a bit cryptic. This guide will try to shed light on those cyptic portions. [GitHub Actions](https://github.com/actions) is a CI system that runs on GitHub. It uses [YAML files](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html) to define what actions it will take. Unfortunately, some of the links between YAML lines and their associated actions are a bit cryptic. This guide will try to shed light on those cryptic portions.
### Basic github file ### Basic GitHub file
Must be located at `{repo root}/.github/workflows/{meaningful_name}.yml`
Must be located at `{repo root}/.github/workflows/{meaningful_name}.yml
```yaml ```yaml
name: KiBot_GitHub_Actions # This is a name. It can be anything you want. name: KiBot_GitHub_Actions # This is a name. It can be anything you want.
on: [push, pull_request] # github triggers for running this. In this example it will run when anything is pushed to github or a pull request is created. on: [push, pull_request] # GitHub triggers for running this. In this example it will run when anything is pushed to GitHub or a pull request is created.
jobs: # List of jobs to be run. Can be used to better organize steps. jobs: # List of jobs to be run. Can be used to better organize steps.
KiBot-Generation: # This is a name. It can be anything you want. KiBot-Generation: # This is a name. It can be anything you want.
runs-on: ubuntu-latest # Don't change runs-on: ubuntu-latest # Don't change
container: ghcr.io/inti-cmnb/kicad7_auto:latest # Don't Change, except if needing older version of KiCAD. container: ghcr.io/inti-cmnb/kicad7_auto_full:latest # Don't Change, except if needing older version of KiCad.
steps: steps:
- name: Checkout repo - name: Checkout repo
uses: actions/checkout@v3 # Github built-in repo checkout step. uses: actions/checkout@v3 # GitHub built-in repo checkout step.
# Start of the KiBot steps # Start of the KiBot steps
- name: Run KiBot - name: Run KiBot
run: | run: |
kibot -e "project_name.kicad_sch" kibot -e "project_name.kicad_sch"
# Post KiBot steps (Optional). # Post KiBot steps (Optional).
- name: Optionally do other things - name: Optionally do other things
run: | run: |
ECHO Run bash commands to do things like commiting the files or adding them as artifacts echo "Run bash commands to do things like committing the files or adding them as artifacts"
``` ```
### Basic KiBot file ### Basic KiBot file
This file will match the syntax and keywords described in the [readme](../README.md).
This file will match the syntax and keywords described in the [readme](https://kibot.readthedocs.io/en/latest/).
```yaml ```yaml
kibot: kibot:
version: 1 version: 1
@ -53,9 +57,9 @@ outputs:
output: '%p-Schematic.%x' output: '%p-Schematic.%x'
``` ```
## Github-specific details ## GitHub-specific details
The `uses: actions/checkout` refers to a specific repo, [Github Actions](https://github.com/actions). The `uses: actions/checkout` refers to a specific repo, [GitHub Actions](https://github.com/actions).
## KiBot Specific details ## KiBot Specific details
@ -63,12 +67,12 @@ The `uses: actions/checkout` refers to a specific repo, [Github Actions](https:/
## Caveats, Gotchyas, and Pitfalls ## Caveats, Gotchyas, and Pitfalls
1. KiBot requires a `{meaningful_name}.kibot.yaml` file name scheme. While most places use `*.yml` and `*.yaml` interchangeably, it is specific here that `*.kibot.yml` won't work. This is especially odd since github uses `*.yml` and kibot uses `*.yaml`. 1. KiBot requires a `{meaningful_name}.kibot.yaml` file name scheme. While most places use `*.yml` and `*.yaml` interchangeably, it is specific here that `*.kibot.yml` won't work. This is especially odd since GitHub uses `*.yml` and kibot uses `*.yaml`.
## Different ways of doing things ## Different ways of doing things
This section will try to describe some different options for doing things within KiBot and Github, and hope to explain pros and cons. This section will try to describe some different options for doing things within KiBot and GitHub, and hope to explain pros and cons.
TODO: Fill this out. - TODO: Fill this out.
TODO: (Topic) github artifacts vs exports commited. - TODO: (Topic) GitHub artifacts vs exports committed.
TODO: (Topic) When to run KiBOT?? ERC/DRC only vs full outputs. - TODO: (Topic) When to run KiBot?? ERC/DRC only vs full outputs.

8
docs/source/usage_with_ci_cd.rst
View File

@ -99,6 +99,14 @@ For more information about the docker images visit
`kicad_debian <https://github.com/INTI-CMNB/kicad_debian>`__ and `kicad_debian <https://github.com/INTI-CMNB/kicad_debian>`__ and
`kicad_auto <https://github.com/INTI-CMNB/kicad_auto>`__. `kicad_auto <https://github.com/INTI-CMNB/kicad_auto>`__.
.. index::
pair: usage; GitHub
GitHub workflows
~~~~~~~~~~~~~~~~
A work-in-progress guide can be found `here <https://github.com/INTI-CMNB/KiBot/blob/dev/docs/GITHUB-ACTIONS-README.md>`__.
.. index:: .. index::
pair: usage; GitHub Actions pair: usage; GitHub Actions