FilesExpand file tree

main

/

openapi-schema-branch.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

executable file

·

46 lines (39 loc) · 2.36 KB

main

/

openapi-schema-branch.js

Copy path

Top

File metadata and controls

• Code
• Blame

executable file

·

46 lines (39 loc) · 2.36 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

#!/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. \n\n If this test is failing after updates to the script/rest directory, run script/rest/update-files.js --decorate-only to re-generate the decorated files from the existing dereferenced files and check those in. \n\n If this test is failing after an update to a package, check the changes the new package makes to the decorated files by running script/rest/update-files.js --decorate-only. If the changes are small style changes that don't impact the overall experience, check the updated decorated file in. Otherwise, more work may be needed to be compatible with the updated package. \n\n For more information, see 'script/rest/README.md'. 🛑`

)

process.exit(1)

}

// All checks pass, ready to ship

console.log('All good 👍')

process.exit(0)