42e785b0a8
* First run of script * Get the app running --- ish * Get NextJS working * Remove `node:` * Get more tests passing in unit directory * Update FailBot test to use nock * Update test.yml * Update Dockerfile * tests/content fixes * Update page.js * Update build-changelog.js * updating tests/routing * Update orphan-tests.js * updating tests/rendering * Update .eslintrc.js * Update .eslintrc.js * Install jest/globals * "linting" tests * staging update to server.mjs * Change '.github/allowed-actions.js' to a ESM export * Lint * Fixes for the main package.json * Move Jest to be last in the npm test command so we can pass args * Just use 'npm run lint' in the npm test command * update algolia label script * update openapi script * update require on openapi * Update enterprise-algolia-label.js * forgot JSON.parse * Update lunr-search-index.js * Always explicitly include process.cwd() for JSON file reads pathed from project root * update graphql/update-files.js script * Update other npm scripts using jest to pass ESM NODE_OPTIONS * Update check-for-enterprise-issues-by-label.js for ESM * Update create-enterprise-issue.js for ESM * Import jest global for browser tests * Convert 'script/deploy' to ESM Co-authored-by: Grace Park <gracepark@github.com> Co-authored-by: James M. Greene <jamesmgreene@github.com>
43 lines
1.8 KiB
JavaScript
Executable File
43 lines
1.8 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
|
|
|
import fs from 'fs'
|
|
import path from 'path'
|
|
import { execSync } from 'child_process'
|
|
import semver from 'semver'
|
|
|
|
/*
|
|
* This script performs two checks to prevent shipping development mode OpenAPI schemas:
|
|
* - Ensures the `info.version` property is a semantic version.
|
|
* In development mode, the `info.version` property is a string
|
|
* containing the `github/github` branch name.
|
|
* - Ensures the decorated schema matches the dereferenced schema.
|
|
* The workflow that calls this script runs `script/rest/update-files.js`
|
|
* with the `--decorate-only` switch then checks to see if files changed.
|
|
*
|
|
*/
|
|
|
|
// Check that the `info.version` property is a semantic version
|
|
const dereferencedDir = path.join(process.cwd(), 'lib/rest/static/dereferenced')
|
|
const schemas = fs.readdirSync(dereferencedDir)
|
|
|
|
schemas.forEach(filename => {
|
|
const schema = JSON.parse(fs.readFileSync(path.join(dereferencedDir, filename)))
|
|
if (!semver.valid(schema.info.version)) {
|
|
console.log(`🚧⚠️ Your branch contains a development mode OpenAPI schema: ${schema.info.version}. This check is a reminder to not 🚢 OpenAPI files in development mode. 🛑`)
|
|
process.exit(1)
|
|
}
|
|
})
|
|
|
|
// Check that the decorated schema matches the dereferenced schema
|
|
const changedFiles = execSync('git diff --name-only HEAD').toString()
|
|
|
|
if(changedFiles !== '') {
|
|
console.log(`These files were changed:\n${changedFiles}`)
|
|
console.log(`🚧⚠️ Your decorated and dereferenced schema files don't match. Ensure you're using decorated and dereferenced schemas from the automatically created pull requests by the 'github-openapi-bot' user. For more information, see 'script/rest/README.md'. 🛑`)
|
|
process.exit(1)
|
|
}
|
|
|
|
// All checks pass, ready to ship
|
|
console.log('All good 👍')
|
|
process.exit(0)
|