From 6915570fac42e964c46c8950d8840b5f013f33dc Mon Sep 17 00:00:00 2001 From: Joe Portner <5295965+jportner@users.noreply.github.com> Date: Tue, 10 Mar 2020 14:24:27 -0400 Subject: [PATCH] Update references to "check_core_api_changes" Several log messages and a CODEOWNERS entry did not get updated when this script was renamed to "check_published_api_changes" in --- .github/CODEOWNERS | 2 +- src/dev/run_check_published_api_changes.ts | 10 +++++----- tasks/config/run.js | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index de74a2c42be8b..552b2666eb3ea 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -133,7 +133,7 @@ /src/legacy/server/saved_objects/ @elastic/kibana-platform /src/legacy/server/status/ @elastic/kibana-platform /src/plugins/status_page/ @elastic/kibana-platform -/src/dev/run_check_core_api_changes.ts @elastic/kibana-platform +/src/dev/run_check_published_api_changes.ts @elastic/kibana-platform # Security /src/core/server/csp/ @elastic/kibana-security @elastic/kibana-platform diff --git a/src/dev/run_check_published_api_changes.ts b/src/dev/run_check_published_api_changes.ts index b12638d9b8661..8bb3fb20cea8b 100644 --- a/src/dev/run_check_published_api_changes.ts +++ b/src/dev/run_check_published_api_changes.ts @@ -133,7 +133,7 @@ const runApiExtractor = ( // ConsoleMessageId.ApiReportNotCopied log.warning(`You have changed the signature of the ${folder} Core API`); log.warning( - 'To accept these changes run `node scripts/check_core_api_changes.js --accept` and then:\n' + + 'To accept these changes run `node scripts/check_published_api_changes.js --accept` and then:\n' + "\t 1. Commit the updated documentation and API review file '" + config.reportFilePath + "' \n" + @@ -225,20 +225,20 @@ async function run( if (opts.help) { process.stdout.write( dedent(chalk` - {dim usage:} node scripts/check_core_api_changes [...options] + {dim usage:} node scripts/check_published_api_changes [...options] Checks for any changes to the Kibana Core API Examples: {dim # Checks for any changes to the Kibana Core API} - {dim $} node scripts/check_core_api_changes + {dim $} node scripts/check_published_api_changes {dim # Checks for any changes to the Kibana Core API and updates the documentation} - {dim $} node scripts/check_core_api_changes --docs + {dim $} node scripts/check_published_api_changes --docs {dim # Checks for and automatically accepts and updates documentation for any changes to the Kibana Core API} - {dim $} node scripts/check_core_api_changes --accept + {dim $} node scripts/check_published_api_changes --accept Options: --accept {dim Accepts all changes by updating the API Review files and documentation} diff --git a/tasks/config/run.js b/tasks/config/run.js index e19de8e894e33..50417ebd8333d 100644 --- a/tasks/config/run.js +++ b/tasks/config/run.js @@ -117,7 +117,7 @@ module.exports = function(grunt) { }), // used by the test tasks - // runs the check_core_api_changes script to ensure API changes are explictily accepted + // runs the check_published_api_changes script to ensure API changes are explictily accepted checkDocApiChanges: scriptWithGithubChecks({ title: 'Check core API changes', cmd: NODE,