Add default config file location for init action #2828
+26
−4
Conversation
This file contains 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
There was a problem hiding this comment.
Pull Request Overview
This PR improves the configuration file handling in the init action by adding logic to use a default configuration file if none is provided.
- Made the configFile variable mutable
- Added a default config file lookup in GITHUB_WORKSPACE
- Logged appropriate messages based on whether the default file is found
Comments suppressed due to low confidence (1)
src/init-action.ts:302
- Consider checking for both undefined and empty string values for configFile, as getOptionalInput may return an empty string when the input is not provided.
if (configFile === undefined) {
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
| logger.info( | ||
| `Using default config file location: ${path.resolve(configFile)}`, | ||
| ); | ||
| } |
There was a problem hiding this comment.
I'm curious whether it would make sense to add a log message if the default file fails to be found, to warn both the users and us when debugging that something has gone very wrong.
There was a problem hiding this comment.
I actually added it in the first commit but thought it would almost always trigger a log that no config was used. I'm okay with either personally
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 pull request includes an update to the
src/init-action.tsfile to improve the handling of the configuration file in therunfunction. The most important change is the addition of logic to set a default configuration file location if none is provided.Improvements to configuration file handling:
src/init-action.ts: Changed theconfigFilevariable to be mutable and added logic to check for a default configuration file location at.github/codeql/codeql.ymlwithin theGITHUB_WORKSPACEif no configuration file is specified. If the default configuration file exists, it setsconfigFileto this location and logs the path. Otherwise, it logs that no configuration file was found.Merge / deployment checklist