Add documentation for SPDX license expression CEL functions#2113
Merged
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
3 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for new CEL helper functions that operate on SPDX license expression strings in policy compliance expressions, supporting issue #872 and corresponding API server changes.
Changes:
- Added example policies for SPDX license-expression allowlisting and rejecting ambiguous (
AND/OR) expressions. - Added a new “SPDX License Expressions” section describing semantics (case handling,
WITH/exceptions). - Extended the function reference with
spdx_expr_*function documentation and examples.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nscuro
force-pushed
the
spdx-expression-policy-funcs-docs
branch
from
90ca367 to
162982e
Compare
Signed-off-by: nscuro <nscuro@protonmail.com>
nscuro
force-pushed
the
spdx-expression-policy-funcs-docs
branch
from
162982e to
5af9957
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds documentation for SPDX license expression CEL functions.
Addressed Issue
Relates to #872
Additional Details
API server PR: DependencyTrack/hyades-apiserver#1947
Checklist
This PR fixes a defect, and I have provided tests to verify that the fix is effectiveThis PR implements an enhancement, and I have provided tests to verify that it works as intendedThis PR introduces changes to the database model, and I have updated the migration changelog accordinglyThis PR introduces new or alters existing behavior, and I have updated the documentation accordingly