Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Customizations.qll files to support integration of sources into Custom CodeQL bundles #178

Merged
merged 1 commit into from
Mar 7, 2025

Conversation

lcartey
Copy link
Contributor

@lcartey lcartey commented Mar 7, 2025

Add Customizations.qll files to the CAP and UI5 library packs. These files enable the packs to be added to a CodeQL CLI custom bundle as a "customization" pack, which enables us to add custom RemoteFlowSources to out-of-the-box queries.

These files enable the packs to be added to a CodeQL CLI bundle
as customization packs, enabling them to modify out-of-the-box
queries.
@lcartey lcartey requested a review from jeongsoolee09 March 7, 2025 11:20
@jeongsoolee09
Copy link
Contributor

Some thoughts:

  • Is it better to put this file Customizations.qll under a directory with the name of the pack? Same goes to UI5.
  • Should we also have a customizations file for XSJS?
  • Overall mechanism: Is the file Customizations.qll treated specially in a bundle? I don't see import Customizations or such in an OOTB query.

@lcartey
Copy link
Contributor Author

lcartey commented Mar 7, 2025

@jeongsoolee09

@jeongsoolee09
Copy link
Contributor

One more: Why are model packs removed from the dependencies of library packs?

@lcartey
Copy link
Contributor Author

lcartey commented Mar 7, 2025

One more: Why are model packs removed from the dependencies of library packs?
The bundles requires that a "customization pack" only depends on the standard library pack, otherwise it creates a dependency loop when it adds a dependency from the standard library pack to the customization pack (e.g. standard library pack -> customization pack -> -> standard library pack).

I also don't think we actually need to reference the model packs in the library pack - it's fine just to reference them in the query packs.

@jeongsoolee09
Copy link
Contributor

Questions answered, code reviewed, :shipit:

@jeongsoolee09 jeongsoolee09 merged commit 8117102 into main Mar 7, 2025
5 checks passed
@jeongsoolee09 jeongsoolee09 deleted the lcartey/add-customizations branch March 7, 2025 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants