Skip to content

Commit

Permalink
Stop checking the metadata from historical files (Qiskit#412)
Browse files Browse the repository at this point in the history
This PR disables the validation of metadata in the historical version
files. This PR unblocks Qiskit#411 where we introduce several historical
versions with files pending to fix in a follow-up.

---------

Co-authored-by: Rebecca Dimock <[email protected]>
Co-authored-by: abbycross <[email protected]>
  • Loading branch information
3 people authored Nov 27, 2023
1 parent 90b4047 commit 6f30fd3
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion scripts/commands/checkMetadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import { globby } from "globby";
const IGNORED_FILES = new Set([
"docs/api/qiskit-ibm-provider/ibm-provider.md",
"docs/api/qiskit/transpiler_builtin_plugins.md",
"docs/api/qiskit/0.44/transpiler_builtin_plugins.md",
"docs/api/qiskit-ibm-runtime/ibm-runtime.md",
"docs/start/__migration-guide-algorithms.md",
"docs/start/__migration-guide-opflow.md",
Expand Down Expand Up @@ -47,6 +46,12 @@ const main = async (): Promise<void> => {
if (IGNORED_FILES.has(file)) {
continue;
}

// Ignore all historical API version files.
if (/.*\/[0-9].*\//.test(file)) {
continue;
}

const metadata = await readMetadata(file);
if (!isValidMetadata(metadata)) {
mdErrors.push(file);
Expand Down

0 comments on commit 6f30fd3

Please sign in to comment.