refactor: rename DEPLOYMENT_CONFIG_FILE to DEPLOYMENT_CONFIG_FILE_PAT…

…H for consistency
github · Jan 10, 2025 · 7fdc33e · 7fdc33e
1 parent eec511b
commit 7fdc33e
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/index.js b/index.js
@@ -28,7 +28,7 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) =>
       if (nop) {
         let filename = env.SETTINGS_FILE_PATH
         if (!deploymentConfig) {
-          filename = env.DEPLOYMENT_CONFIG_FILE
+          filename = env.DEPLOYMENT_CONFIG_FILE_PATH
           deploymentConfig = {}
         }
         const nopcommand = new NopCommand(filename, repo, null, e, 'ERROR')
@@ -53,7 +53,7 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) =>
       if (nop) {
         let filename = env.SETTINGS_FILE_PATH
         if (!deploymentConfig) {
-          filename = env.DEPLOYMENT_CONFIG_FILE
+          filename = env.DEPLOYMENT_CONFIG_FILE_PATH
           deploymentConfig = {}
         }
         const nopcommand = new NopCommand(filename, repo, null, e, 'ERROR')
@@ -78,7 +78,7 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) =>
       if (nop) {
         let filename = env.SETTINGS_FILE_PATH
         if (!deploymentConfig) {
-          filename = env.DEPLOYMENT_CONFIG_FILE
+          filename = env.DEPLOYMENT_CONFIG_FILE_PATH
           deploymentConfig = {}
         }
         const nopcommand = new NopCommand(filename, repo, null, e, 'ERROR')
@@ -104,7 +104,7 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) =>
       if (nop) {
         let filename = env.SETTINGS_FILE_PATH
         if (!deploymentConfig) {
-          filename = env.DEPLOYMENT_CONFIG_FILE
+          filename = env.DEPLOYMENT_CONFIG_FILE_PATH
           deploymentConfig = {}
         }
         const nopcommand = new NopCommand(filename, repo, null, e, 'ERROR')
@@ -123,7 +123,7 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) =>
    */
   async function loadYamlFileSystem () {
     if (deploymentConfig === undefined) {
-      const deploymentConfigPath = env.DEPLOYMENT_CONFIG_FILE
+      const deploymentConfigPath = env.DEPLOYMENT_CONFIG_FILE_PATH
       if (fs.existsSync(deploymentConfigPath)) {
         deploymentConfig = yaml.load(fs.readFileSync(deploymentConfigPath))
       } else {

diff --git a/lib/deploymentConfig.js b/lib/deploymentConfig.js
@@ -13,7 +13,7 @@ class DeploymentConfig {
   static overridevalidators = {}
 
   static {
-    const deploymentConfigPath = process.env.DEPLOYMENT_CONFIG_FILE ? process.env.DEPLOYMENT_CONFIG_FILE : 'deployment-settings.yml'
+    const deploymentConfigPath = env.DEPLOYMENT_CONFIG_FILE_PATH
     if (fs.existsSync(deploymentConfigPath)) {
       this.config = yaml.load(fs.readFileSync(deploymentConfigPath))
     } else {

diff --git a/lib/env.js b/lib/env.js
@@ -2,7 +2,7 @@ module.exports = {
   ADMIN_REPO: process.env.ADMIN_REPO || 'admin',
   CONFIG_PATH: process.env.CONFIG_PATH || '.github',
   SETTINGS_FILE_PATH: process.env.SETTINGS_FILE_PATH || 'settings.yml',
-  DEPLOYMENT_CONFIG_FILE: process.env.DEPLOYMENT_CONFIG_FILE || 'deployment-settings.yml',
+  DEPLOYMENT_CONFIG_FILE_PATH: process.env.DEPLOYMENT_CONFIG_FILE || 'deployment-settings.yml',
   CREATE_PR_COMMENT: process.env.CREATE_PR_COMMENT || 'true',
   CREATE_ERROR_ISSUE: process.env.CREATE_ERROR_ISSUE || 'true',
   BLOCK_REPO_RENAME_BY_HUMAN: process.env.BLOCK_REPO_RENAME_BY_HUMAN || 'false'

diff --git a/test/unit/lib/env.test.js b/test/unit/lib/env.test.js
@@ -18,8 +18,8 @@ describe('env', () => {
       expect(SETTINGS_FILE_PATH).toEqual('settings.yml')
     })
 
-    it('loads default DEPLOYMENT_CONFIG_FILE if not passed', () => {
-      const SETTINGS_FILE_PATH = envTest.DEPLOYMENT_CONFIG_FILE
+    it('loads default DEPLOYMENT_CONFIG_FILE_PATH if not passed', () => {
+      const SETTINGS_FILE_PATH = envTest.DEPLOYMENT_CONFIG_FILE_PATH
       expect(SETTINGS_FILE_PATH).toEqual('deployment-settings.yml')
     })
 
@@ -47,8 +47,8 @@ describe('env', () => {
       expect(CONFIG_PATH).toEqual('.config')
       const SETTINGS_FILE_PATH = envTest.SETTINGS_FILE_PATH
       expect(SETTINGS_FILE_PATH).toEqual('safe-settings.yml')
-      const DEPLOYMENT_CONFIG_FILE = envTest.DEPLOYMENT_CONFIG_FILE
-      expect(DEPLOYMENT_CONFIG_FILE).toEqual('safe-settings-deployment.yml')
+      const DEPLOYMENT_CONFIG_FILE_PATH = envTest.DEPLOYMENT_CONFIG_FILE_PATH
+      expect(DEPLOYMENT_CONFIG_FILE_PATH).toEqual('safe-settings-deployment.yml')
       const CREATE_PR_COMMENT = envTest.CREATE_PR_COMMENT
       expect(CREATE_PR_COMMENT).toEqual('false')
     })