Skip to content

Commit

Permalink
rename docs script file
Browse files Browse the repository at this point in the history
  • Loading branch information
Liza K committed Mar 9, 2020
1 parent 212a969 commit a87c701
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
"uiFramework:documentComponent": "cd packages/kbn-ui-framework && yarn documentComponent",
"kbn:watch": "node scripts/kibana --dev --logging.json=false",
"build:types": "tsc --p tsconfig.types.json",
"core:acceptApiChanges": "node scripts/check_core_api_changes.js --accept",
"docs:acceptApiChanges": "node scripts/check_published_api_changes.js --accept",
"kbn:bootstrap": "yarn build:types && node scripts/register_git_hook",
"spec_to_console": "node scripts/spec_to_console",
"backport-skip-ci": "backport --prDescription \"[skip-ci]\"",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
*/

require('../src/setup_node_env');
require('../src/dev/run_check_core_api_changes');
require('../src/dev/run_check_published_api_changes');
2 changes: 1 addition & 1 deletion src/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ well documented. To reduce the chance of regressions, development on the Core AP
process described below. Changes to the API signature which have not been accepted will cause the build to fail.

When changes to the Core API's signatures are made, the following process needs to be followed:
1. After changes have been made, run `yarn core:acceptApiChanges` which performs the following:
1. After changes have been made, run `yarn docs:acceptApiChanges` which performs the following:
- Recompiles all typescript typings files
- Updates the API review files `src/core/public/kibana.api.md` and `src/core/server/kibana.api.md`
- Updates the Core API documentation in `docs/development/core/`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
* under the License.
*/

/* eslint-disable no-console */

import { ToolingLog } from '@kbn/dev-utils';
import {
Extractor,
Expand Down Expand Up @@ -95,7 +97,6 @@ const runBuildTypes = async () => {
const runApiDocumenter = async (folder: string) => {
const sourceFolder = `./build/${folder}`;
const targetFolder = `./docs/development/${folder}`;
// eslint-disable-next-line no-console
console.log(`Generating docs from ${sourceFolder} into ${targetFolder}...`);
await execa('api-documenter', ['generate', '-i', sourceFolder, '-o', targetFolder], {
preferLocal: true,
Expand All @@ -105,7 +106,6 @@ const runApiDocumenter = async (folder: string) => {
const renameExtractedApiPackageName = async (folder: string) => {
const fname = getReportFileName(folder);
const jsonApiFile = `build/${folder}/${fname}.api.json`;
// eslint-disable-next-line no-console
console.log(`Updating ${jsonApiFile}...`);
const json = JSON.parse(fs.readFileSync(jsonApiFile).toString());
json.name = json.canonicalReference = `kibana-plugin-${folder.replace(/\//g, '-')}`;
Expand Down Expand Up @@ -266,6 +266,6 @@ async function run(
process.exitCode = 1;
}
})().catch(e => {
// eslint-disable-next-line no-console
console.log(e);
process.exitCode = 1;
});

0 comments on commit a87c701

Please sign in to comment.