chore(shared): warning for the queue names

novuhq · Dec 8, 2023 · c8bec33 · c8bec33 · github-actions · Dec 8, 2023
1 parent 1d69665
commit c8bec33
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/libs/shared/src/config/job-queue.ts b/libs/shared/src/config/job-queue.ts
@@ -1,3 +1,9 @@
+/**
+ * WARNING:
+ * DO NOT CHANGE THE VALUES OF THIS ENUM WITHOUT HAVING AN APPROPRIATE MIGRATION PLAN IN PLACE.
+ * THE VALUES CORRESPONDING TO QUEUE NAMES AND CHANGING THEM WILL BREAK THE SYSTEM RESULTING
+ * IN STALLED JOBS IN THE QUEUE.
+ */
 export enum JobTopicNameEnum {
  EXECUTION_LOG = 'execution-logs',
  ACTIVE_JOBS_METRIC = 'metric-active-jobs',