github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-01-05 06:00:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Further standardize doc URL messages

Browse Source 
Always say "see $URL for more information" without parentheses.
This commit is contained in:
Angela P Wen
2024-07-23 14:16:18 +02:00
parent 7ad1090882
commit edfef2739a
18 changed files with 27 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/autobuild.ts
View File

@@ -103,7 +103,7 @@ export async function determineAutobuildLanguages(
.join(
" and ",
)}, you must replace the autobuild step of your workflow with custom build steps. ` +
`For more information, see ${DocUrl.SPECIFY_BUILD_STEPS_MANUALLY}`
`See ${DocUrl.SPECIFY_BUILD_STEPS_MANUALLY} for more information.`
);
}
@@ -132,14 +132,14 @@ export async function setupCppAutobuild(codeql: CodeQL, logger: Logger) {
logger.info(
`Disabling ${featureName} as we are on a self-hosted runner.${
getWorkflowEventName() !== "dynamic"
? ` To override this, set the ${envVar} environment variable to 'true' in your workflow (see ${DocUrl.DEFINE_ENV_VARIABLES} for more information).`
? ` To override this, set the ${envVar} environment variable to 'true' in your workflow. See ${DocUrl.DEFINE_ENV_VARIABLES} for more information.`
: ""
}`,
);
core.exportVariable(envVar, "false");
} else {
logger.info(
`Enabling ${featureName}. This can be disabled by setting the ${envVar} environment variable to 'false' (see ${DocUrl.DEFINE_ENV_VARIABLES} for more information).`,
`Enabling ${featureName}. This can be disabled by setting the ${envVar} environment variable to 'false'. See ${DocUrl.DEFINE_ENV_VARIABLES} for more information.`,
);
core.exportVariable(envVar, "true");
}

2
src/fingerprints.ts
View File

@@ -261,7 +261,7 @@ export async function addFingerprints(
logger: Logger,
): Promise<SarifFile> {
logger.info(
`Adding fingerprints to SARIF file. For more information, see ${DocUrl.TRACK_CODE_SCANNING_ALERTS_ACROSS_RUNS}`,
`Adding fingerprints to SARIF file. See ${DocUrl.TRACK_CODE_SCANNING_ALERTS_ACROSS_RUNS} for more information.`,
);
// Gather together results for the same file and construct
// callbacks to accept hashes for that file and update the location

2
src/status-report.ts
View File

@@ -415,7 +415,7 @@ export async function sendStatusReport<S extends StatusReportBase>(
'Workflows triggered by Dependabot on the "push" event run with read-only access. ' +
"Uploading Code Scanning results requires write access. " +
'To use Code Scanning with Dependabot, please ensure you are using the "pull_request" event for this workflow and avoid triggering on the "push" event for Dependabot branches. ' +
`See ${DocUrl.SCANNING_ON_PUSH} for more information on how to configure these events."`,
`See ${DocUrl.SCANNING_ON_PUSH} for more information on how to configure these events.`,
);
} else {
core.warning(e.message);

2
src/trap-caching.ts
View File

@@ -234,7 +234,7 @@ export async function cleanupTrapCaches(
logger.warning(
"Could not cleanup TRAP caches as the token did not have the required permissions. " +
'To clean up TRAP caches, ensure the token has the "actions:write" permission. ' +
`For more information, see " + ${DocUrl.ASSIGNING_PERMISSIONS_TO_JOBS}`,
`See ${DocUrl.ASSIGNING_PERMISSIONS_TO_JOBS} for more information.`,
);
} else {
logger.info(`Failed to cleanup TRAP caches, continuing. Details: ${e}`);