Merge pull request #146 from atlanhq/DQ-470-add-deprecation-callout-main

DQ-470 enhancement(comment): add deprecation callout in createIssueComment
atlanhq · Nov 7, 2024 · a580b6b · a580b6b
2 parents d141f08 + 3b79e56
commit a580b6b
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@
 
 ![atlan<>dbt](https://user-images.githubusercontent.com/14099191/209542321-54d5557e-8abf-4d9a-9f6d-dcacb856f25f.png)
 
+> [!WARNING] 
+> Deprecation Notice: This action is scheduled for deprecation and will no longer be supported after June 2025. To ensure a smooth transition and continued functionality, please migrate to [atlan-action](https://github.com/marketplace/actions/atlan-action) by following the migration guide available [here](https://ask.atlan.com/hc/en-us/articles/11121331752719).
+
 ## Overview
 
 _Have you ever changed a dbt model only to later find it broke a downstream table or dashboard? 💔_

diff --git a/adapters/integrations/github-integration.js b/adapters/integrations/github-integration.js
@@ -35,6 +35,7 @@ import IntegrationInterface from "./contract/contract.js";
 import github from "@actions/github";
 import logger from "../logger/logger.js";
 import stringify from "json-stringify-safe";
+
 var headSHA;
 const integrationName = "github";
 export default class GitHubIntegration extends IntegrationInterface {
@@ -915,8 +916,15 @@ export default class GitHubIntegration extends IntegrationInterface {
 
     const { pull_request } = context?.payload || {};
 
+    // Deprecation callout
+    let deprecationCallout = `:warning: Deprecation Notice: This action is scheduled for deprecation and will no longer be supported after June 2025. To ensure a smooth transition and continued functionality, please migrate to atlan-action by following the migration guide available [here](https://ask.atlan.com/hc/en-us/articles/11121331752719).`
+
+    deprecationCallout = "\n\n---\n\n" + deprecationCallout;
+
     content = `<!-- ActionCommentIdentifier: atlan-dbt-action -->
-${content}`;
+${content}
+
+${deprecationCallout}`;
 
     const commentObj = {
       ...context.repo,

diff --git a/adapters/integrations/gitlab-integration.js b/adapters/integrations/gitlab-integration.js
@@ -43,6 +43,7 @@ import { Gitlab } from "@gitbeaker/rest";
 import IntegrationInterface from "./contract/contract.js";
 import logger from "../logger/logger.js";
 import stringify from "json-stringify-safe";
+
 const integrationName = "gitlab";
 var CI_MERGE_REQUEST_IID;
 
@@ -599,8 +600,15 @@ export default class GitLabIntegration extends IntegrationInterface {
       "createIssueComment"
     );
 
+    // Deprecation callout
+    let deprecationCallout = `:warning: Deprecation Notice: This action is scheduled for deprecation and will no longer be supported after June 2025. To ensure a smooth transition and continued functionality, please migrate to atlan-action by following the migration guide available [here](https://ask.atlan.com/hc/en-us/articles/11121331752719).`
+
+    deprecationCallout = "\n\n---\n\n" + deprecationCallout;
+
     content = `<!-- ActionCommentIdentifier: atlan-dbt-action -->
-${content}`;
+${content}
+
+${deprecationCallout}`;
 
     if (IS_DEV) {
       logger.withInfo(

diff --git a/dist/index.js b/dist/index.js
@@ -25595,6 +25595,7 @@ var github = __nccwpck_require__(5438);
 
 
 
+
 var headSHA;
 const integrationName = "github";
 class GitHubIntegration extends IntegrationInterface {
@@ -26475,8 +26476,15 @@ class GitHubIntegration extends IntegrationInterface {
 
     const { pull_request } = context?.payload || {};
 
+    // Deprecation callout
+    let deprecationCallout = `:warning: Deprecation Notice: This action is scheduled for deprecation and will no longer be supported after June 2025. To ensure a smooth transition and continued functionality, please migrate to atlan-action by following the migration guide available [here](https://ask.atlan.com/hc/en-us/articles/11121331752719).`
+
+    deprecationCallout = "\n\n---\n\n" + deprecationCallout;
+
     content = `<!-- ActionCommentIdentifier: atlan-dbt-action -->
-${content}`;
+${content}
+
+${deprecationCallout}`;
 
     const commentObj = {
       ...context.repo,
@@ -34200,6 +34208,7 @@ var {
 
 
 
+
 const gitlab_integration_integrationName = "gitlab";
 var CI_MERGE_REQUEST_IID;
 
@@ -34756,8 +34765,15 @@ class GitLabIntegration extends IntegrationInterface {
       "createIssueComment"
     );
 
+    // Deprecation callout
+    let deprecationCallout = `:warning: Deprecation Notice: This action is scheduled for deprecation and will no longer be supported after June 2025. To ensure a smooth transition and continued functionality, please migrate to atlan-action by following the migration guide available [here](https://ask.atlan.com/hc/en-us/articles/11121331752719).`
+
+    deprecationCallout = "\n\n---\n\n" + deprecationCallout;
+
     content = `<!-- ActionCommentIdentifier: atlan-dbt-action -->
-${content}`;
+${content}
+
+${deprecationCallout}`;
 
     if (IS_DEV) {
       logger_logger.withInfo(