From da0ec9f4e1c06d4e92e41918cb048c96724818d0 Mon Sep 17 00:00:00 2001 From: Lucas Costi Date: Thu, 22 Jul 2021 23:52:46 +1000 Subject: [PATCH] Add setup-node to OpenAPI decorate workflow (#20469) * Add setup-node to OpenAPI decorate workflow * Add description of the workflow --- .github/workflows/openapi-decorate.yml | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/.github/workflows/openapi-decorate.yml b/.github/workflows/openapi-decorate.yml index e720ebaef0..8cb36f8067 100644 --- a/.github/workflows/openapi-decorate.yml +++ b/.github/workflows/openapi-decorate.yml @@ -1,8 +1,8 @@ name: OpenAPI generate decorated schema files -# **What it does**: -# **Why we have it**: -# **Who does it impact**: +# **What it does**: On 'Update OpenAPI Descriptions' PRs opened by github-openapi-bot, this workflow runs the script to generate the decorated OpenAPI files and commit them to the PR. +# **Why we have it**: So we can consume OpenAPI changes, decorate them, and publish them to the REST API docs. +# **Who does it impact**: Anyone making OpenAPI changes in `github/github`, and wanting to get them published on the docs site. on: workflow_dispatch: @@ -21,6 +21,12 @@ jobs: - name: Checkout repository code uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + - name: Setup node + uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f + with: + node-version: 16.x + cache: npm + - name: Install dependencies run: npm ci