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

[DOCs] Added example of how to hide KiCost secrets on CI/CD

This commit is contained in:
Salvador E. Tropea 2022-12-15 14:22:57 -03:00
parent 302a762e7a
commit 52fc3e610f
3 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -1522,6 +1522,9 @@ Notes:
- `kicost_api_enable`: [string|list(string)=''] List of KiCost APIs to enable.
- `kicost_config`: [string=''] KiCost configuration file. It contains the keys for the different distributors APIs.
The regular KiCost config is used when empty.
Important for CI/CD environments: avoid exposing your API secrets!
To understand how to achieve this, and also how to make use of the cache please visit the
[kicost_ci_test](https://github.com/set-soft/kicost_ci_test) repo.
- `kicost_dist_desc`: [boolean=false] Used to add a column with the distributor's description. So you can check this is the right component.
- `logo_scale`: [number=2] Scaling factor for the logo. Note that this value isn't honored by all spreadsheet software.
- `max_col_width`: [number=60] [20,999] Maximum column width (characters).

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

@ -369,7 +369,10 @@ outputs:
# [string|list(string)=''] List of KiCost APIs to enable
kicost_api_enable: ''
# [string=''] KiCost configuration file. It contains the keys for the different distributors APIs.
# The regular KiCost config is used when empty
# The regular KiCost config is used when empty.
# Important for CI/CD environments: avoid exposing your API secrets!
# To understand how to achieve this, and also how to make use of the cache please visit the
# [kicost_ci_test](https://github.com/set-soft/kicost_ci_test) repo
kicost_config: ''
# [boolean=false] Used to add a column with the distributor's description. So you can check this is the right component
kicost_dist_desc: false

5
kibot/out_bom.py
View File

@ -315,7 +315,10 @@ class BoMXLSX(BoMLinkable):
""" Used to add a column with the distributor's description. So you can check this is the right component """
self.kicost_config = ''
""" KiCost configuration file. It contains the keys for the different distributors APIs.
The regular KiCost config is used when empty """
The regular KiCost config is used when empty.
Important for CI/CD environments: avoid exposing your API secrets!
To understand how to achieve this, and also how to make use of the cache please visit the
[kicost_ci_test](https://github.com/set-soft/kicost_ci_test) repo """
self.specs = False
""" *Enable Specs worksheet creation. Contains specifications for the components.
Works with only some KiCost APIs """