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

[DOCs] Added note about `checkout` GitHub action 

- It produces a shallow checkout

Related to #308
This commit is contained in:
Salvador E. Tropea 2022-09-30 12:39:28 -03:00
parent a9d5b8cd58
commit fe223e64f6
3 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1698,7 +1698,7 @@ Notes:
read https://stackoverflow.com/questions/1248029/git-pull-error-entry-foo-not-uptodate-cannot-merge.
- `fuzz`: [number=5] [0,100] Color tolerance (fuzzyness) for the `stats` mode.
- `new`: [string|list(string)] The file you want to compare. Leave it blank for the current PCB/SCH.
A list is accepted only for the `multivar` type.
A list is accepted only for the `multivar` type. Consult the `old` option for more information.
- `new_type`: [string='current'] [git,file,output,multivar,current] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
Use `current` for the currently loaded PCB/Schematic.
Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output.
@ -1710,6 +1710,8 @@ Notes:
reference to the changes in the PCB/SCH. The `n` value is how many
changes in the history you want to go back. A 0 is the same as `HEAD`,
a 1 means the last time the PCB/SCH was changed, etc.
Important: when using the `checkout` GitHub action you just get the
last commit. To clone the full repo use `fetch-depth: '0'`.
- `old_type`: [string='git'] [git,file,output,multivar] How to interpret the `old` name. Use `git` for a git hash, branch, etc.
Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output.
Use `multivar` to specify a reference file when `new_type` is also `multivar`.

6
docs/samples/generic_plot.kibot.yaml
View File

@ -496,7 +496,7 @@ outputs:
# [number=5] [0,100] Color tolerance (fuzzyness) for the `stats` mode
fuzz: 5
# [string|list(string)] The file you want to compare. Leave it blank for the current PCB/SCH.
# A list is accepted only for the `multivar` type
# A list is accepted only for the `multivar` type. Consult the `old` option for more information
new: ''
# [string='current'] [git,file,output,multivar,current] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
# Use `current` for the currently loaded PCB/Schematic.
@ -509,7 +509,9 @@ outputs:
# As `HEAD` is for the whole repo you can use `KIBOT_LAST-n` to make
# reference to the changes in the PCB/SCH. The `n` value is how many
# changes in the history you want to go back. A 0 is the same as `HEAD`,
# a 1 means the last time the PCB/SCH was changed, etc
# a 1 means the last time the PCB/SCH was changed, etc.
# Important: when using the `checkout` GitHub action you just get the
# last commit. To clone the full repo use `fetch-depth: '0'`
old: 'HEAD'
# [string='git'] [git,file,output,multivar] How to interpret the `old` name. Use `git` for a git hash, branch, etc.
# Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output.

6
kibot/out_diff.py
View File

@ -54,14 +54,16 @@ class DiffOptions(BaseOptions):
As `HEAD` is for the whole repo you can use `KIBOT_LAST-n` to make
reference to the changes in the PCB/SCH. The `n` value is how many
changes in the history you want to go back. A 0 is the same as `HEAD`,
a 1 means the last time the PCB/SCH was changed, etc """
a 1 means the last time the PCB/SCH was changed, etc.
Important: when using the `checkout` GitHub action you just get the
last commit. To clone the full repo use `fetch-depth: '0'` """
self.old_type = 'git'
""" [git,file,output,multivar] How to interpret the `old` name. Use `git` for a git hash, branch, etc.
Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output.
Use `multivar` to specify a reference file when `new_type` is also `multivar` """
self.new = ''
""" [string|list(string)] The file you want to compare. Leave it blank for the current PCB/SCH.
A list is accepted only for the `multivar` type """
A list is accepted only for the `multivar` type. Consult the `old` option for more information """
self.new_type = 'current'
""" [git,file,output,multivar,current] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
Use `current` for the currently loaded PCB/Schematic.