chore: disable old api reference generation
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
This commit is contained in:
@@ -69,17 +69,6 @@ jobs:
|
||||
with:
|
||||
cache-prefix: ${{ runner.os }}-v22.x
|
||||
|
||||
- name: build API reference
|
||||
run: yarn build:api-docs
|
||||
|
||||
- name: upload API reference
|
||||
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
|
||||
with:
|
||||
name: stable-reference
|
||||
path: docs/reference/
|
||||
if-no-files-found: error
|
||||
retention-days: 1
|
||||
|
||||
# Use the lower-level cache actions for the success cache, so that we can store the cache even on failed builds
|
||||
- name: restore package-docs cache
|
||||
uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
|
||||
@@ -89,13 +78,13 @@ jobs:
|
||||
restore-keys: |
|
||||
${{ runner.os }}-v${{ matrix.node-version }}-package-docs-stable-
|
||||
|
||||
- name: build API reference (beta)
|
||||
- name: build API reference
|
||||
run: yarn backstage-repo-tools package-docs
|
||||
|
||||
- name: upload API reference (beta)
|
||||
- name: upload API reference
|
||||
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
|
||||
with:
|
||||
name: stable-reference-beta
|
||||
name: stable-reference
|
||||
path: type-docs/
|
||||
if-no-files-found: error
|
||||
retention-days: 1
|
||||
@@ -153,17 +142,6 @@ jobs:
|
||||
with:
|
||||
cache-prefix: ${{ runner.os }}-v22.x
|
||||
|
||||
- name: build API reference
|
||||
run: yarn build:api-docs
|
||||
|
||||
- name: upload API reference
|
||||
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
|
||||
with:
|
||||
name: next-reference
|
||||
path: docs/reference/
|
||||
if-no-files-found: error
|
||||
retention-days: 1
|
||||
|
||||
# Use the lower-level cache actions for the success cache, so that we can store the cache even on failed builds
|
||||
- name: restore package-docs cache
|
||||
uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
|
||||
@@ -173,13 +151,13 @@ jobs:
|
||||
restore-keys: |
|
||||
${{ runner.os }}-v${{ matrix.node-version }}-package-docs-
|
||||
|
||||
- name: build API reference (beta)
|
||||
- name: build API reference
|
||||
run: yarn backstage-repo-tools package-docs
|
||||
|
||||
- name: upload API reference (beta)
|
||||
- name: upload API reference
|
||||
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
|
||||
with:
|
||||
name: next-reference-beta
|
||||
name: next-reference
|
||||
path: type-docs/
|
||||
if-no-files-found: error
|
||||
retention-days: 1
|
||||
@@ -317,12 +295,12 @@ jobs:
|
||||
|
||||
- uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
|
||||
with:
|
||||
name: stable-reference-beta
|
||||
path: microsite/build/api/stable/
|
||||
name: stable-reference
|
||||
path: microsite/build/api/
|
||||
|
||||
- uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
|
||||
with:
|
||||
name: next-reference-beta
|
||||
name: next-reference
|
||||
path: microsite/build/api/next/
|
||||
|
||||
- name: Check the build output
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
"private": true,
|
||||
"license": "Apache-2.0",
|
||||
"scripts": {
|
||||
"build": "node scripts/pre-build.js && docusaurus build",
|
||||
"build": "docusaurus build",
|
||||
"deploy": "docusaurus deploy",
|
||||
"docusaurus": "docusaurus",
|
||||
"generate-openapi-docs": "yarn docusaurus clean-api-docs all && yarn docusaurus gen-api-docs all",
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
/*
|
||||
* Copyright 2022 The Backstage Authors
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
const { existsSync, writeFileSync, mkdirSync } = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
const PLACEHOLDER = `---
|
||||
id: "index"
|
||||
title: "Package Index"
|
||||
description: "Index of all Backstage Packages"
|
||||
---
|
||||
Run \`yarn build:api-docs\` to generate the API docs.
|
||||
`;
|
||||
|
||||
async function main() {
|
||||
const referencesDir = '../docs/reference';
|
||||
if (!existsSync(referencesDir)) {
|
||||
mkdirSync(referencesDir);
|
||||
writeFileSync(path.join(referencesDir, 'index.md'), PLACEHOLDER);
|
||||
}
|
||||
}
|
||||
|
||||
main().catch(error => {
|
||||
console.error(error.stack);
|
||||
process.exit(1);
|
||||
});
|
||||
Reference in New Issue
Block a user