cd74b07da1
* Bump actions/checkout from 2.3.4 to 2.3.5
Bumps [actions/checkout](https://github.com/actions/checkout) from 2.3.4 to 2.3.5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](5a4ac9002d...1e204e9a92)
---
updated-dependencies:
- dependency-name: actions/checkout
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>
* test
* removing test, works
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Grace Park <gracepark@github.com>
49 lines
1.8 KiB
YAML
49 lines
1.8 KiB
YAML
name: OpenAPI dev mode check
|
|
|
|
# **What it does**: Checks that the files in lib/rest/static/decorated match
|
|
# the files in lib/rest/static/dereferenced. Checks that the decorated
|
|
# schemas in lib/rest/static/decorated are not in development mode.
|
|
# Development mode schemas have a branch name and development mode tag in the
|
|
# info.version property.
|
|
# **Why we have it**: To ensure that we aren't every shipping decorated schemas
|
|
# that are out of sync with the source derefereced schema. To ensure that
|
|
# decorated schemas generated locally are not published. Locally generated
|
|
# decorated schemas are pushing up to the remote for staging purposes only.
|
|
# **Who does it impact**: Docs content writers updating REST API docs and
|
|
# the docs engineering team as maintainers of the scripts and workflows.
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches:
|
|
- main
|
|
pull_request:
|
|
paths:
|
|
- 'lib/rest/static/**'
|
|
- 'script/rest/**/*.js'
|
|
- 'package*.json'
|
|
|
|
jobs:
|
|
check-schema-versions:
|
|
if: ${{ github.repository == 'github/docs-internal' }}
|
|
runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
|
|
steps:
|
|
- name: Checkout repository code
|
|
uses: actions/checkout@1e204e9a9253d643386038d443f96446fa156a97
|
|
|
|
- name: Setup node
|
|
uses: actions/setup-node@270253e841af726300e85d718a5f606959b2903c
|
|
with:
|
|
node-version: 16.8.x
|
|
cache: npm
|
|
|
|
- name: Install dependencies
|
|
run: npm ci
|
|
|
|
# Differences between decorated and dereferenced files indicates a problem
|
|
- name: Generate decorated files to check that there are no differences
|
|
run: script/rest/update-files.js --decorate-only
|
|
|
|
- name: Check if deref/decorated schemas are dev mode and that they match
|
|
run: .github/actions-scripts/openapi-schema-branch.js
|