Skip to content

Commit cb4cdec

Browse files
committed
docs: updating checker table
1 parent acbddf3 commit cb4cdec

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ We use [pyupgrade](https://github.com/asottile/pyupgrade) to make sure our synta
237237

238238
We also have a spell checker set up to help us avoid typos in documentation. The [spelling actions readme file](https://github.com/intel/cve-bin-tool/tree/main/.github/actions/spelling) gives more information including how to add new words to the dictionary if needed.
239239

240-
We also have a tool to help make sure that new checkers are added to the tables in our documentation. [The format_checkers code is here](https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/format_checkers.py), if you're curious.
240+
We also have a tool to help make sure that new checkers are added to the tables in our documentation, this is automatically done with github actions. [The format_checkers code is here](https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/format_checkers.py), if you're curious.
241241

242242
You can view all the config files for GitHub Actions (what we use for Continuous Integration (CI)) in [the .github/workflows directory](https://github.com/intel/cve-bin-tool/tree/main/.github/workflows).
243243

cve_bin_tool/checkers/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -428,3 +428,7 @@ return following dictionary.
428428
In most of the cases, Just providing above five class attributes will be enough.
429429
But sometimes, you need to override this method to correctly detect version of
430430
the product. We have done this in the checkers of `python`, `sqlite` and `kerberos`.
431+
432+
## Updating checker table
433+
You do not need to run format_checkers.py to update the checker table in documentation.
434+
A pull request with updated checker table is created automatically when a new checker is merged.

0 commit comments

Comments
 (0)