robojerk/codeql-action

Add doc describing CLI version marker files

Browse source
This commit is contained in:
Henry Mercer 2023-01-12 15:51:12 +00:00
parent a89ad76881
commit 31c7ce1ce4
3 changed files with 21 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lib/setup-codeql.js generated
View file

@ -65,6 +65,16 @@ function getCodeQLActionRepository(logger) {
return util.getRequiredEnvParam("GITHUB_ACTION_REPOSITORY"); return util.getRequiredEnvParam("GITHUB_ACTION_REPOSITORY");
} }
exports.getCodeQLActionRepository = getCodeQLActionRepository; exports.getCodeQLActionRepository = getCodeQLActionRepository;
/**
* CodeQL bundles are currently tagged in the form `codeql-bundle-yyyymmdd`, so it is not possible
* to directly find the CodeQL bundle release for a particular CLI version.
*
* To get around this, we add a `codeql-version-x.y.z.txt` asset to each bundle release that
* specifies the CLI version for that bundle release.
*
* In the medium term, we should migrate to a tagging scheme that allows us to directly find the
* CodeQL bundle release for a particular CLI version, for example `codeql-bundle-vx.y.z`.
*/
async function findCodeQLBundleTagDotcomOnly(cliVersion, logger) { async function findCodeQLBundleTagDotcomOnly(cliVersion, logger) {
logger.debug(`Trying to find the CodeQL bundle release for CLI version ${cliVersion}.`); logger.debug(`Trying to find the CodeQL bundle release for CLI version ${cliVersion}.`);
const apiClient = api.getApiClient(); const apiClient = api.getApiClient();

2
lib/setup-codeql.js.map
View file

File diff suppressed because one or more lines are too long

10
src/setup-codeql.ts
View file

@ -48,6 +48,16 @@ export function getCodeQLActionRepository(logger: Logger): string {
return util.getRequiredEnvParam("GITHUB_ACTION_REPOSITORY"); return util.getRequiredEnvParam("GITHUB_ACTION_REPOSITORY");
} }
/**
* CodeQL bundles are currently tagged in the form `codeql-bundle-yyyymmdd`, so it is not possible
* to directly find the CodeQL bundle release for a particular CLI version.
*
* To get around this, we add a `codeql-version-x.y.z.txt` asset to each bundle release that
* specifies the CLI version for that bundle release.
*
* In the medium term, we should migrate to a tagging scheme that allows us to directly find the
* CodeQL bundle release for a particular CLI version, for example `codeql-bundle-vx.y.z`.
*/
export async function findCodeQLBundleTagDotcomOnly( export async function findCodeQLBundleTagDotcomOnly(
cliVersion: string, cliVersion: string,
logger: Logger logger: Logger