From 269c2cc40467d43d424b0e09ad0ce9cda57db8ea Mon Sep 17 00:00:00 2001
From: Sarah Yasonik <syasonik@gitlab.com>
Date: Fri, 19 Jul 2024 05:24:37 +0000
Subject: [PATCH] Fix language specification on analytics instrumentation
scripts
---
.../internal_event_instrumentation/migration.md | 2 +-
.../internal_event_instrumentation/quick_start.md | 2 +-
.../internal_analytics/metrics/metrics_lifecycle.md | 2 +-
scripts/internal_events/cli.rb | 3 +--
scripts/internal_events/product_group_renamer.rb | 7 +++----
5 files changed, 7 insertions(+), 9 deletions(-)
mode change 100644 => 100755 scripts/internal_events/product_group_renamer.rb
diff --git a/doc/development/internal_analytics/internal_event_instrumentation/migration.md b/doc/development/internal_analytics/internal_event_instrumentation/migration.md
index caf2844caa11..95aae0e77672 100644
--- a/doc/development/internal_analytics/internal_event_instrumentation/migration.md
+++ b/doc/development/internal_analytics/internal_event_instrumentation/migration.md
@@ -48,7 +48,7 @@ In addition, you have to create definitions for the metrics that you would like
To generate metric definitions, you can use the generator:
```shell
-ruby scripts/internal_events/cli.rb
+scripts/internal_events/cli.rb
```
The generator walks you through the required inputs step-by-step.
diff --git a/doc/development/internal_analytics/internal_event_instrumentation/quick_start.md b/doc/development/internal_analytics/internal_event_instrumentation/quick_start.md
index 18f25a7ba97b..319c629d147e 100644
--- a/doc/development/internal_analytics/internal_event_instrumentation/quick_start.md
+++ b/doc/development/internal_analytics/internal_event_instrumentation/quick_start.md
@@ -20,7 +20,7 @@ In order to instrument your code with Internal Events Tracking you need to do th
To create event and/or metric definitions, use the `internal_events` generator from the `gitlab` directory:
```shell
-ruby scripts/internal_events/cli.rb
+scripts/internal_events/cli.rb
```
This CLI will help you create the correct defintion files based on your specific use-case, then provide code examples for instrumentation and testing.
diff --git a/doc/development/internal_analytics/metrics/metrics_lifecycle.md b/doc/development/internal_analytics/metrics/metrics_lifecycle.md
index 146768391cb7..8fc315f35622 100644
--- a/doc/development/internal_analytics/metrics/metrics_lifecycle.md
+++ b/doc/development/internal_analytics/metrics/metrics_lifecycle.md
@@ -66,7 +66,7 @@ The `product_group_renamer` script can update all the definitions so you do not
For example, if the group 5-min-app was renamed to 2-min-app, you can update the relevant files like this:
```shell
-$ ruby scripts/internal_events/product_group_renamer.rb 5-min-app 2-min-app
+$ scripts/internal_events/product_group_renamer.rb 5-min-app 2-min-app
Updated '5-min-app' to '2-min-app' in 3 files
Updated files:
diff --git a/scripts/internal_events/cli.rb b/scripts/internal_events/cli.rb
index 50aceea93c5d..92cdfa8392f5 100755
--- a/scripts/internal_events/cli.rb
+++ b/scripts/internal_events/cli.rb
@@ -1,7 +1,6 @@
+#!/usr/bin/env ruby
# frozen_string_literal: true
-# !/usr/bin/env ruby
-#
# Generate a metric/event files in the correct locations.
require 'tty-prompt'
diff --git a/scripts/internal_events/product_group_renamer.rb b/scripts/internal_events/product_group_renamer.rb
old mode 100644
new mode 100755
index 2f2680c4172a..26ce60238041
--- a/scripts/internal_events/product_group_renamer.rb
+++ b/scripts/internal_events/product_group_renamer.rb
@@ -1,7 +1,6 @@
+#!/usr/bin/env ruby
# frozen_string_literal: true
-# !/usr/bin/env ruby
-#
# Update group name in all relevant metric and event definition after a group name change.
require 'json'
@@ -54,10 +53,10 @@ def rename_product_group(old_name, new_name)
When a group is renamed, this script replaces the value for "product_group" in all matching event & metric definitions.
Format:
- ruby #{$PROGRAM_NAME} OLD_NAME NEW_NAME
+ #{$PROGRAM_NAME} OLD_NAME NEW_NAME
Example:
- ruby #{$PROGRAM_NAME} pipeline_authoring renamed_pipeline_authoring
+ #{$PROGRAM_NAME} pipeline_authoring renamed_pipeline_authoring
TEXT
exit
end
--
GitLab