Add repository property for tools input#4037
Open
mbg wants to merge 8 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Warning
- Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.
Pull request overview
Adds feature-flagged support for sourcing the tools input from repository properties.
Changes:
- Adds
github-codeql-toolsproperty and feature flag. - Introduces effective-input precedence and enforcement handling.
- Integrates repository properties into
initandsetup-codeql.
Show a summary per file
| File | Description |
|---|---|
src/config/inputs.ts |
Resolves effective tools input. |
src/config/inputs.test.ts |
Tests input precedence and enforcement. |
src/feature-flags.ts |
Defines the new feature flag. |
src/feature-flags/properties.ts |
Adds and loads the tools property. |
src/feature-flags/properties.test.ts |
Tests tools-property parsing. |
src/init-action.ts |
Uses the effective tools value during initialization. |
src/setup-codeql-action.ts |
Adds property support to setup. |
lib/entry-points.js |
Generated file; excluded from review by policy. |
Review details
Files excluded by content exclusion policy (1)
- lib/entry-points.js
- Files reviewed: 7/8 changed files
- Comments generated: 3
- Review effort level: Medium
Contributor
There was a problem hiding this comment.
Warning
- Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.
Review details
Files excluded by content exclusion policy (1)
- lib/entry-points.js
- Files reviewed: 9/10 changed files
- Comments generated: 2
- Review effort level: Medium
| ): Promise<ComputedInput | undefined> { | ||
| const name = InputName.Tools; | ||
| const input = action.actions.getOptionalInput(name); | ||
| const propertyValue = repositoryProperties[RepositoryPropertyName.TOOLS]; |
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.
This PR attempts to simplify and tidy up #3766 while resolving conflicts with recent changes to the codebase.
Compared with #3766, there are the following changes:
github-codeql-tools-modeproperty. The justification for this is that in Advanced Setup workflows, thetoolsinput provided in the workflow takes precedence. The value of the repository property can be enforced with a prefix!. This is similar to the+notation for thequeriesinput, where+means "combine rather than replace".This PR does not change the telemetry to include the source of the effectivetoolsvalue. However, it does lay the groundwork for it with theEffectiveInputtype andgetToolsInputreturns a suitable value. Once we have merged relevant backend changes, the intention is to then make use ofEffectiveInputvalues in the status reports. This will avoid duplication of work across similar inputs (i.e. rather than adding several new status reports properties for each, we will have an array ofEffectiveInputvalues). That's outside the scope of this PR though.github-codeql-toolsrepository property for tools input #3766, this PR also updatessetup-codeqlto load the repository properties. Since the loaded values are not persisted, this means that bothsetup-codeqlandinitcould load them. However, we don't yet allowsetup-codeqlin the same workflow asinit, so this is not an issue right now. If we allowsetup-codeqlbeforeinitin the future, we will need to review potentially duplicated work across both steps in any case.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
dynamicworkflows (Default Setup, Code Quality, ...).Products:
analysis-kinds: code-scanning.analysis-kinds: code-quality.Environments:
github.comand/or GitHub Enterprise Cloud with Data Residency.How did/will you validate this change?
.test.tsfiles).pr-checks).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist