Skip to content

Commit 853aad4

Browse files
committed
Update README for platform specific bundles and bump version
1 parent 764f77e commit 853aad4

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For more details on CodeQL customization packs see the section [CodeQL customiza
1818
The CodeQL bundle application can be installed using `pip` with the command:
1919

2020
```bash
21-
python3.11 -m pip install https://github.com/rvermeulen/codeql-bundle/releases/download/v0.1.5/codeql_bundle-0.1.5-py3-none-any.whl
21+
python3.11 -m pip install https://github.com/rvermeulen/codeql-bundle/releases/download/v0.1.8/codeql_bundle-0.1.8-py3-none-any.whl
2222
```
2323

2424
## Usage
@@ -31,7 +31,14 @@ You can see the packs available in your workspace by running `codeql pack ls --
3131
With both a CodeQL bundle and a CodeQL workspace you can create a bundle with the command:
3232

3333
```bash
34-
codeql-bundle --bundle <path-to-bundle> --output codeql-custom-bundle.tar.gz --workspace <path-to-workspace> --log INFO
34+
codeql-bundle --bundle <path-to-bundle> --output codeql-custom-bundle.tar.gz --workspace <path-to-workspace> --log INFO <packs>
35+
```
36+
37+
If the source bundle is the platform agnostic bundle then you can create platform specific bundles to reduce the size of the used bundle(s).
38+
The following example creates platform specific bundles for all the currently supported platforms.
39+
40+
```bash
41+
codeql-bundle --bundle <path-to-platform-agnostic-bundle> --output <path-to-bundles-dir> --workspace <path-to-workspace> --log INFO -p linux64 -p osx64 -p win64 <packs>
3542
```
3643

3744
## CodeQL customization packs

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "codeql-bundle"
3-
version = "0.1.7"
3+
version = "0.1.8"
44
description = "Tool to create custom CodeQL bundles"
55
authors = ["Remco Vermeulen <[email protected]>"]
66
readme = "README.md"

0 commit comments

Comments
 (0)