From f334cc45761ca611270d428f41e47f7fc811ba0f Mon Sep 17 00:00:00 2001 From: Marcus Andersson Date: Wed, 14 Oct 2020 17:03:35 +0200 Subject: [PATCH] Docs: generate packages docs before syncing to website (#27879) * updated to latest version of api-documenter. * saved lockfile after upgrade. * adding yarn to docker environment. * adding packages to trigger paths. * added steps to workflow for generating docs. * reverted back to api-documenter 0.9.3 --- .github/workflows/publish.yml | 8 ++++++++ package.json | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 6702e205485..e2481391b56 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -6,6 +6,7 @@ on: - master paths: - 'docs/sources/**' + - 'packages/grafana-*/**' jobs: build: @@ -14,6 +15,13 @@ jobs: steps: - uses: actions/checkout@v1 + - name: generate-packages-docs + uses: actions/setup-node@v1 + id: generate-docs + with: + node-version: '12' + - run: yarn install --pure-lockfile --no-progress + - run: ./scripts/ci-reference-docs-build.sh - name: publish-to-git uses: ./.github/actions/gha-publish-to-git id: publish diff --git a/package.json b/package.json index d9c91e50d1d..7dba3ec2e1e 100644 --- a/package.json +++ b/package.json @@ -75,6 +75,7 @@ "@emotion/core": "10.0.27", "@grafana/api-documenter": "0.9.3", "@grafana/eslint-config": "2.0.3", + "@grafana/api-extractor": "7.10.1", "@rtsao/plugin-proposal-class-properties": "7.0.1-patch.1", "@testing-library/jest-dom": "^5.11.3", "@testing-library/react": "^10.4.8", @@ -205,7 +206,6 @@ "zone.js": "0.7.8" }, "dependencies": { - "@grafana/api-extractor": "7.10.1", "@grafana/slate-react": "0.22.9-grafana", "@reduxjs/toolkit": "1.3.4", "@torkelo/react-select": "3.0.8",