Skip to content

Commit ac7a49c

Browse files
committed
Update README.md
- Fix a grammar error. - Add section on performance tweaking.
1 parent e648391 commit ac7a49c

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,15 @@ To create a CodeQL customization pack follow these steps:
7676
4. Add the Java standard library as a dependency for development of the customizations using the CodeQL CLI as follows: `codeql pack add --dir=java-customizations codeql/java-all` **Note: ensure the version is compatible with the CodeQL bundle being targeted!**
7777

7878
You can now add your customizations directly in the `Customizations.qll` or other modules that are imported by the `Customizations.qll`.
79-
For example, see our test cases for [Ruby](test/qlpacks/contoso/ruby-customizations/contoso/ruby_customizations/Customizations.qll) and [Java](test/qlpacks/contoso/java-customizations/contoso/java_customizations/Customizations.qll)
79+
For examples see our test cases for [Ruby](test/qlpacks/contoso/ruby-customizations/contoso/ruby_customizations/Customizations.qll) and [Java](test/qlpacks/contoso/java-customizations/contoso/java_customizations/Customizations.qll)
80+
81+
# Performance
82+
83+
The creation of a bundle includes the compilation of added CodeQL query packs as well as CodeQL query packs relying on a CodeQL library pack that has been customized.
84+
Depending on the amount of packs that need to be compiled this can be resource intensive.
85+
By default we only process two CodeQL packs concurrently. However, if a machine with better specs is available this limitation can be increased by setting the `concurrency-limit` value.
86+
An indication of resource contention on the Action runner is when the action fails with the CodeQL CLI exiting with a `null` return value.
87+
This indicates the process has been killed by the operating system (this has been only observed for Linux).
8088

8189
# Limitations
8290

0 commit comments

Comments
 (0)