Skip to content
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

Link checker: One release note per FileBatch #862

Merged
merged 6 commits into from
Feb 22, 2024
Merged

Link checker: One release note per FileBatch #862

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
41fb208
one release note per FileBatch
arnaucasau Feb 21, 2024
5741f81
merge historical checking and release notes
arnaucasau Feb 22, 2024
f4a5d91
incorporate feedback
arnaucasau Feb 22, 2024
08ee256
Merge branch 'main' into AC/check-release-notes
arnaucasau Feb 22, 2024
e080042
fix broken links
arnaucasau Feb 22, 2024
8284ac8
Merge branch 'AC/check-release-notes' of https://github.com/arnaucasa…
arnaucasau Feb 22, 2024
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
84 changes: 62 additions & 22 deletions scripts/commands/checkLinks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
// copyright notice, and modified files need to carry a notice indicating
// that they have been altered from the originals.

import { readdir } from "fs/promises";
import { readFile, readdir } from "fs/promises";

import { globby } from "globby";
import yargs from "yargs/yargs";
Expand All @@ -19,6 +19,7 @@ import { hideBin } from "yargs/helpers";
import { pathExists } from "../lib/fs";
import { File } from "../lib/links/LinkChecker";
import { FileBatch } from "../lib/links/FileBatch";
import { QISKIT_MISSING_VERSION_MAPPING } from "../lib/qiskitMetapackage";

// While these files don't exist in this repository, the link
// checker should assume that they exist in production.
Expand Down Expand Up @@ -111,20 +112,25 @@ async function determineFileBatches(args: Arguments): Promise<FileBatch[]> {
result.push(...devBatches);
}

if (args.historicalApis) {
const provider = await determineHistoricalFileBatches(
"qiskit-ibm-provider",
["docs/api/qiskit/*.md"],
);
const runtime = await determineHistoricalFileBatches("qiskit-ibm-runtime", [
"docs/api/qiskit/providers_models.md",
]);
let qiskit: FileBatch[] = [];
if (!args.skipBrokenHistorical) {
qiskit = await determineHistoricalFileBatches("qiskit");
}
result.push(...provider, ...runtime, ...qiskit);
}
const provider = await determineHistoricalFileBatches(
"qiskit-ibm-provider",
["docs/api/qiskit/*.md"],
args.historicalApis,
);
const runtime = await determineHistoricalFileBatches(
"qiskit-ibm-runtime",
["docs/api/qiskit/providers_models.md"],
args.historicalApis,
);

const qiskit = await determineHistoricalFileBatches(
"qiskit",
[],
args.historicalApis && !args.skipBrokenHistorical,
args.qiskitReleaseNotes,
);

result.push(...provider, ...runtime, ...qiskit);

return result;
}
Expand All @@ -141,6 +147,8 @@ async function determineCurrentDocsFileBatch(
// Ignore dev version
"!docs/api/{qiskit,qiskit-ibm-provider,qiskit-ibm-runtime}/dev/*",
"!public/api/{qiskit,qiskit-ibm-provider,qiskit-ibm-runtime}/dev/*",
// Ignore Qiskit release notes
"!docs/api/qiskit/release-notes/*",
];
const toLoad = [
// The 0.46 docs are used by release notes for APIs that were removed in 1.0.
arnaucasau marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -149,6 +157,7 @@ async function determineCurrentDocsFileBatch(
"docs/api/qiskit/0.45/qiskit.quantum_info.{OneQubitEuler,TwoQubitBasis,XX}Decomposer.md",
"docs/api/qiskit/0.45/qiskit.transpiler.synthesis.aqc.AQC.md",
"docs/api/qiskit/0.45/{tools,quantum_info,synthesis_aqc}.md",
"docs/api/qiskit/release-notes/index.md",
];

if (!args.currentApis) {
Expand All @@ -158,9 +167,15 @@ async function determineCurrentDocsFileBatch(
toLoad.push("docs/api/{qiskit,qiskit-ibm-provider,qiskit-ibm-runtime}/*");
}

if (!args.qiskitReleaseNotes) {
toCheck.push("!docs/api/qiskit/release-notes/*");
toLoad.push("docs/api/qiskit/release-notes/index.md");
if (args.qiskitReleaseNotes) {
const currentVersion = JSON.parse(
await readFile(`docs/api/qiskit/_package.json`, "utf-8"),
)
.version.split(".")
.slice(0, -1)
.join(".");

toCheck.push(`docs/api/qiskit/release-notes/${currentVersion}.md`);
}

let description: string;
Expand Down Expand Up @@ -203,19 +218,44 @@ async function determineDevFileBatches(): Promise<FileBatch[]> {

async function determineHistoricalFileBatches(
projectName: string,
toLoad: string[] = [],
extraFilesToLoad: string[],
arnaucasau marked this conversation as resolved.
Show resolved Hide resolved
checkHistoricalApiDocs: boolean = true,
arnaucasau marked this conversation as resolved.
Show resolved Hide resolved
checkSeparateReleaseNotes: boolean = false,
): Promise<FileBatch[]> {
if (!checkHistoricalApiDocs && !checkSeparateReleaseNotes) {
return [];
}

const historicalFolders = (
await readdir(`docs/api/${projectName}`, { withFileTypes: true })
).filter((file) => file.isDirectory() && file.name.match(/[0-9].*/));

const result = [];
for (const folder of historicalFolders) {
const fileBatch = await FileBatch.fromGlobs(
[
const toCheck: string[] = [];
const toLoad = [...extraFilesToLoad];

if (checkHistoricalApiDocs) {
arnaucasau marked this conversation as resolved.
Show resolved Hide resolved
toCheck.push(
`docs/api/${projectName}/${folder.name}/*`,
`public/api/${projectName}/${folder.name}/objects.inv`,
],
);
}

if (checkSeparateReleaseNotes) {
toCheck.push(`docs/api/${projectName}/release-notes/${folder.name}.md`);

// Some legacy release notes don't have docs, and their links point to the closest
// next version present in the repo. QISKIT_MISSING_VERSION_MAPPING contains what
// versions point to which other version
const versionsToLoad = QISKIT_MISSING_VERSION_MAPPING.get(folder.name);
versionsToLoad?.forEach((version) => {
arnaucasau marked this conversation as resolved.
Show resolved Hide resolved
toCheck.push(`docs/api/${projectName}/release-notes/${version}.md`);
});
}

const fileBatch = await FileBatch.fromGlobs(
toCheck,
toLoad,
`${projectName} v${folder.name}`,
);
Expand Down
160 changes: 1 addition & 159 deletions scripts/lib/api/Pkg.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { join } from "path/posix";
import { findLegacyReleaseNotes } from "./releaseNotes";
import { removePrefix, removeSuffix } from "../stringUtils";
import { getRoot } from "../fs";
import { determineHistoricalQiskitGithubUrl } from "../qiskitMetapackage";

/**
* Simple interface for scripts/command/updateApiDocs.ts
Expand Down Expand Up @@ -224,165 +225,6 @@ export class Pkg {
}
}

const QISKIT_METAPACKAGE_TO_TERRA = new Map([
["0.44", "0.25"],
["0.43", "0.24"],
["0.42", "0.23"],
["0.41", "0.23"],
["0.40", "0.23"],
["0.39", "0.22"],
["0.38", "0.21"],
["0.37", "0.21"],
["0.36", "0.20"],
["0.35", "0.20"],
["0.34", "0.19"],
["0.33", "0.19"],
["0.32", "0.18"],
["0.31", "0.18"],
["0.30", "0.18"],
["0.29", "0.18"],
["0.28", "0.18"],
["0.27", "0.17"],
["0.26", "0.17"],
["0.25", "0.17"],
["0.24", "0.16"],
["0.19", "0.14"],
]);
const QISKIT_METAPACKAGE_TO_AER = new Map([
["0.43", "0.12"],
["0.42", "0.12"],
["0.41", "0.11"],
["0.40", "0.11"],
["0.39", "0.11"],
["0.38", "0.11"],
["0.37", "0.10"],
["0.36", "0.10"],
["0.35", "0.10"],
["0.34", "0.10"],
["0.33", "0.9"],
["0.32", "0.9"],
["0.31", "0.9"],
["0.30", "0.9"],
["0.29", "0.8"],
["0.28", "0.8"],
["0.27", "0.8"],
["0.26", "0.8"],
["0.25", "0.8"],
["0.24", "0.7"],
["0.19", "0.5"],
]);
const QISKIT_METAPACKAGE_TO_IGNIS = new Map([
["0.36", "0.7"],
["0.35", "0.7"],
["0.34", "0.7"],
["0.33", "0.7"],
["0.32", "0.6"],
["0.31", "0.6"],
["0.30", "0.6"],
["0.29", "0.6"],
["0.28", "0.6"],
["0.27", "0.6"],
["0.26", "0.6"],
["0.25", "0.6"],
["0.24", "0.5"],
["0.19", "0.3"],
]);
const QISKIT_METAPACKAGE_TO_AQUA = new Map([
["0.32", "0.9"],
["0.31", "0.9"],
["0.30", "0.9"],
["0.29", "0.9"],
["0.28", "0.9"],
["0.27", "0.9"],
["0.26", "0.9"],
["0.25", "0.9"],
["0.24", "0.8"],
["0.19", "0.7"],
]);
const QISKIT_METAPACKAGE_TO_IBMQ_PROVIDER = new Map([
["0.43", "0.20"],
["0.42", "0.20"],
["0.41", "0.20"],
["0.40", "0.19"],
["0.39", "0.19"],
["0.38", "0.19"],
["0.37", "0.19"],
["0.36", "0.19"],
["0.35", "0.18"],
["0.34", "0.18"],
["0.33", "0.18"],
["0.32", "0.18"],
["0.31", "0.17"],
["0.30", "0.16"],
["0.29", "0.16"],
["0.28", "0.15"],
["0.27", "0.14"],
["0.26", "0.13"],
["0.25", "0.12"],
["0.24", "0.12"],
["0.19", "0.7"],
]);

function determineHistoricalQiskitGithubUrl(
metapackageVersion: string,
fileName: string,
): string {
const getOrThrow = (mapping: Map<string, string>): string => {
const result = mapping.get(metapackageVersion);
if (result === undefined) {
throw new Error(
`No compatible version found for the file ${fileName} with qiskit-metapackage ${metapackageVersion}}`,
);
}
return result;
};

/**
* Special case:
* The file `qiskit/optimization/converters/quadratic_program_to_negative_value_oracle` existed in qiskit-aqua
* patch 0.7.3, but was removed in patch 0.7.4. Thus, the branch stable/0.7 doesn't contain the file, and
* we can only access it through the tag 0.7.3
*/
if (
metapackageVersion == "0.19" &&
fileName ==
"qiskit/optimization/converters/quadratic_program_to_negative_value_oracle"
) {
return `https://github.com/qiskit-community/qiskit-aqua/tree/0.7.3/${fileName}.py`;
}

let slug: string;
let version: string;
if (
fileName.includes("qiskit_aer") ||
fileName.includes("qiskit/aer") ||
fileName.includes("qiskit/providers/aer")
) {
slug = "qiskit/qiskit-aer";
version = getOrThrow(QISKIT_METAPACKAGE_TO_AER);
} else if (fileName.includes("qiskit/ignis")) {
slug = "qiskit-community/qiskit-ignis";
version = getOrThrow(QISKIT_METAPACKAGE_TO_IGNIS);
} else if (
fileName.includes("qiskit/aqua") ||
fileName.includes("qiskit/chemistry") ||
fileName.includes("qiskit/finance") ||
fileName.includes("qiskit/ml") ||
fileName.includes("qiskit/optimization")
) {
slug = "qiskit-community/qiskit-aqua";
version = getOrThrow(QISKIT_METAPACKAGE_TO_AQUA);
} else if (fileName.includes("qiskit/providers/ibmq")) {
slug = "qiskit/qiskit-ibmq-provider";
version = getOrThrow(QISKIT_METAPACKAGE_TO_IBMQ_PROVIDER);
} else {
slug = "qiskit/qiskit";
version = getOrThrow(QISKIT_METAPACKAGE_TO_TERRA);
}

return `https://github.com/${slug}/tree/stable/${version}/${fileName}.py`;
}

function transformLink(link: Link): Link | undefined {
const updateText = link.url === link.text;
const prefixes = [
Expand Down
Loading
Loading