Reorganize `scripts` folder to prepare for packaging JS scripts (#1742)
Some projects are going to start using our JS scripts soon. To help us with packaging the scripts, this PR bundles all of the JS into `scripts/js` whereas before it was spread out over `scripts/commands` and `scripts/lib`. Beyond packaging the scripts, I think this is a cleaner organization anyways to differentiate between our three scripts projects: * `js` * `nb-tester` * `pr-previews` (renamed from `pr_previews`) (In a follow up, we might want to centralize all of our config into `scripts/config`)
This commit is contained in:
parent
604f5baba2
commit
00275a26cb
|
@ -29,6 +29,6 @@ jobs:
|
|||
python-version: "3.11"
|
||||
|
||||
- name: Clean up PR previews
|
||||
run: scripts/pr_previews/cleanup.py
|
||||
run: scripts/pr-previews/cleanup.py
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
|
|
|
@ -54,15 +54,15 @@ jobs:
|
|||
|
||||
- name: Build static site
|
||||
run: >
|
||||
scripts/pr_previews/builder.py
|
||||
scripts/pr-previews/builder.py
|
||||
${{ env.PR_PREVIEW_PATH }}
|
||||
--basepath /documentation/${{ env.PR_PREVIEW_PATH }}
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
run: scripts/pr_previews/deploy.py ${{ env.PR_PREVIEW_PATH }}
|
||||
run: scripts/pr-previews/deploy.py ${{ env.PR_PREVIEW_PATH }}
|
||||
|
||||
- name: Determine deployment result
|
||||
run: scripts/pr_previews/poll_deployment.py ${{ env.PR_PREVIEW_URL }}
|
||||
run: scripts/pr-previews/poll_deployment.py ${{ env.PR_PREVIEW_URL }}
|
||||
- name: Report deployment status
|
||||
uses: bobheadxi/deployments@v1
|
||||
if: always()
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
docs
|
||||
translations
|
||||
scripts/lib/api/testdata
|
||||
scripts/js/lib/api/testdata
|
||||
.mypy_cache
|
||||
|
|
28
package.json
28
package.json
|
@ -5,23 +5,23 @@
|
|||
"author": "Qiskit Development Team",
|
||||
"license": "Apache-2.0",
|
||||
"scripts": {
|
||||
"check": "npm run check:qiskit-bot && npm run check:patterns-index && npm run check:metadata && npm run check:spelling && npm run check:internal-links && npm run check:orphan-pages && npm run check:fmt",
|
||||
"check:metadata": "node -r esbuild-register scripts/commands/checkMetadata.ts",
|
||||
"check:spelling": "cspell --relative --no-progress docs/**/*.md* docs/api/**/*.md* --config cspell/cSpell.json",
|
||||
"check:fmt": "prettier --check .",
|
||||
"check:internal-links": "node -r esbuild-register scripts/commands/checkInternalLinks.ts",
|
||||
"check:external-links": "node -r esbuild-register scripts/commands/checkExternalLinks.ts",
|
||||
"check:pages-render": "node -r esbuild-register scripts/commands/checkPagesRender.ts",
|
||||
"check:patterns-index": "node -r esbuild-register scripts/commands/checkPatternsIndex.ts",
|
||||
"check:orphan-pages": "node -r esbuild-register scripts/commands/checkOrphanPages.ts",
|
||||
"check:qiskit-bot": "node -r esbuild-register scripts/commands/checkQiskitBotFiles.ts",
|
||||
"check:stale-images": "node -r esbuild-register scripts/commands/checkStaleImages.ts",
|
||||
"fmt": "prettier --write .",
|
||||
"test": "jest",
|
||||
"typecheck": "tsc",
|
||||
"regen-apis": "node -r esbuild-register scripts/commands/api/regenerateApiDocs.ts",
|
||||
"gen-api": "node -r esbuild-register scripts/commands/api/updateApiDocs.ts",
|
||||
"make-historical": "node -r esbuild-register scripts/commands/api/convertApiDocsToHistorical.ts"
|
||||
"check": "npm run check:qiskit-bot && npm run check:patterns-index && npm run check:metadata && npm run check:spelling && npm run check:internal-links && npm run check:orphan-pages && npm run check:fmt",
|
||||
"check:metadata": "node -r esbuild-register scripts/js/commands/checkMetadata.ts",
|
||||
"check:spelling": "cspell --relative --no-progress docs/**/*.md* docs/api/**/*.md* --config cspell/cSpell.json",
|
||||
"check:fmt": "prettier --check .",
|
||||
"check:internal-links": "node -r esbuild-register scripts/js/commands/checkInternalLinks.ts",
|
||||
"check:external-links": "node -r esbuild-register scripts/js/commands/checkExternalLinks.ts",
|
||||
"check:pages-render": "node -r esbuild-register scripts/js/commands/checkPagesRender.ts",
|
||||
"check:patterns-index": "node -r esbuild-register scripts/js/commands/checkPatternsIndex.ts",
|
||||
"check:orphan-pages": "node -r esbuild-register scripts/js/commands/checkOrphanPages.ts",
|
||||
"check:qiskit-bot": "node -r esbuild-register scripts/js/commands/checkQiskitBotFiles.ts",
|
||||
"check:stale-images": "node -r esbuild-register scripts/js/commands/checkStaleImages.ts",
|
||||
"regen-apis": "node -r esbuild-register scripts/js/commands/api/regenerateApiDocs.ts",
|
||||
"gen-api": "node -r esbuild-register scripts/js/commands/api/updateApiDocs.ts",
|
||||
"make-historical": "node -r esbuild-register scripts/js/commands/api/convertApiDocsToHistorical.ts"
|
||||
},
|
||||
"dependencies": {
|
||||
"cheerio": "^1.0.0-rc.12",
|
||||
|
|
|
@ -10,8 +10,6 @@
|
|||
// copyright notice, and modified files need to carry a notice indicating
|
||||
// that they have been altered from the originals.
|
||||
|
||||
// To run:
|
||||
// node -r esbuild-register scripts/commands/find-stale-images.ts
|
||||
import { zxMain } from "../lib/zx";
|
||||
import { $ } from "zx";
|
||||
import { globby } from "globby";
|
|
@ -63,7 +63,7 @@ test("qiskit-sphinx-theme", async () => {
|
|||
const markdownFolder = pkg.outputDir(docsBaseFolder);
|
||||
|
||||
await runConversionPipeline(
|
||||
"scripts/lib/api/testdata/qiskit-sphinx-theme",
|
||||
"scripts/js/lib/api/testdata/qiskit-sphinx-theme",
|
||||
docsBaseFolder,
|
||||
publicBaseFolder,
|
||||
pkg,
|
|
@ -14,8 +14,8 @@ import { describe, expect, test } from "@jest/globals";
|
|||
import { ObjectsInv, ObjectsInvEntry } from "./objectsInv";
|
||||
import { unlink, stat } from "fs/promises";
|
||||
|
||||
const TEST_FOLDER = "scripts/lib/api/testdata/";
|
||||
const TEMP_FOLDER = "scripts/lib/api/testdata/temp/";
|
||||
const TEST_FOLDER = "scripts/js/lib/api/testdata/";
|
||||
const TEMP_FOLDER = "scripts/js/lib/api/testdata/temp/";
|
||||
|
||||
describe("objects.inv", () => {
|
||||
test("read file and decompress", async () => {
|
|
@ -16,7 +16,7 @@ import path from "path";
|
|||
import { $ } from "zx/core";
|
||||
|
||||
export function getRoot() {
|
||||
return path.normalize(`${__dirname}/../../`);
|
||||
return path.normalize(`${__dirname}/../../../`);
|
||||
}
|
||||
|
||||
export async function pathExists(path: string) {
|
Loading…
Reference in New Issue