Skip to content

Add default config file location for init action #2828

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.

Sign up for GitHub

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

Closed
wants to merge 6 commits into from
Closed

Add default config file location for init action #2828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a1a82f7
feat: add default config file location for init action
GeekMasher Mar 26, 2025
4768172
fix: Remove logging
GeekMasher Mar 26, 2025
860883f
feat: Update lib/dist
GeekMasher Mar 26, 2025
f05f6de
docs: Update CHANGELOG to reflect default location for CodeQL configu…
GeekMasher Mar 27, 2025
cdf12ea
Merge branch 'main' of https://github.com/GeekMasher/codeql-action in…
GeekMasher Mar 31, 2025
55f15c5
feat: Update lib/dist
GeekMasher Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ See the [releases page](https://github.com/github/codeql-action/releases) for th

## [UNRELEASED]

No user facing changes.
- Default location for CodeQL configurations to be located and automatically loaded if present.

## 3.28.13 - 24 Mar 2025

Expand Down
9 changes: 8 additions & 1 deletion lib/init-action.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib/init-action.js.map
View file
Open in desktop

Large diffs are not rendered by default.

17 changes: 16 additions & 1 deletion src/init-action.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,22 @@ async function run() {

core.exportVariable(EnvVar.INIT_ACTION_HAS_RUN, "true");

const configFile = getOptionalInput("config-file");
let configFile = getOptionalInput("config-file");
if (configFile === undefined) {
const defaultLocation = path.join(
getRequiredEnvParam("GITHUB_WORKSPACE"),
".github",
"codeql",
"codeql.yml",
);

if (fs.existsSync(defaultLocation)) {
configFile = defaultLocation;
logger.info(
`Using default config file location: ${path.resolve(configFile)}`,
);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

try {
const statusReportBase = await createStatusReportBase(
Expand Down
Loading