Skip to content

Commit

Permalink
Update references to "check_core_api_changes"
Browse files Browse the repository at this point in the history
Several log messages and a CODEOWNERS entry did not get updated
when this script was renamed to "check_published_api_changes" in
  • Loading branch information
jportner committed Mar 10, 2020
1 parent ecac63f commit 6915570
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions src/dev/run_check_published_api_changes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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" +
Expand Down Expand Up @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion tasks/config/run.js
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 6915570

Please sign in to comment.