From 4fd743ccd9f9b8af7d21d50c49c32f5ef8e99195 Mon Sep 17 00:00:00 2001 From: Dolan Antenucci Date: Wed, 14 Feb 2024 14:27:15 -0700 Subject: [PATCH 1/4] Adding optional CONFIG_PATH env var support --- lib/env.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/env.js b/lib/env.js index a0880f46..e96a75a0 100644 --- a/lib/env.js +++ b/lib/env.js @@ -1,6 +1,6 @@ module.exports = { ADMIN_REPO: process.env.ADMIN_REPO || 'admin', - CONFIG_PATH: '.github', + 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', CREATE_PR_COMMENT: process.env.CREATE_PR_COMMENT || 'true', From 5adedc996c52a4c3395e52b1d9e81dcdbc236703 Mon Sep 17 00:00:00 2001 From: Dolan Antenucci Date: Mon, 26 Feb 2024 12:48:52 -0700 Subject: [PATCH 2/4] Updating hardcoded config-paths to use env object --- README.md | 3 ++- index.js | 8 ++++---- lib/deploymentConfig.js | 4 ++-- lib/settings.js | 10 +++++----- test/unit/lib/env.test.js | 8 ++++++++ 5 files changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1f82ee2e..3c308eac 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,8 @@ 1. Org-level settings are defined in `.github/settings.yml` > **Note** > It is possible to override this behavior and specify a different filename for the `settings` yml repo.
- > This could be done by setting an `env` variable called `SETTINGS_FILE_PATH`. + > This could be done by setting an `env` variable called `SETTINGS_FILE_PATH`.
+ > Similarly, the `.github` directory can be overridden with an `env` variable called `CONFIG_PATH`. 2. `Suborg` level settings. A `suborg` is an arbitrary collection of repos belonging to projects, business units, or teams. The `suborg` settings reside in a yaml file for each `suborg` in the `.github/suborgs` folder. 3. `Repo` level settings. They reside in a repo specific yaml in `.github/repos` folder diff --git a/index.js b/index.js index 3ba9bebe..7491b3dd 100644 --- a/index.js +++ b/index.js @@ -108,7 +108,7 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) => } function getAllChangedSubOrgConfigs (payload) { - const settingPattern = new Glob('.github/suborgs/*.yml') + const settingPattern = new Glob(`${env.CONFIG_PATH}/suborgs/*.yml`) // Changes will be an array of files that were added const added = payload.commits.map(c => { return (c.added.filter(s => { @@ -132,7 +132,7 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) => } function getAllChangedRepoConfigs (payload, owner) { - const settingPattern = new Glob('.github/repos/*.yml') + const settingPattern = new Glob(`${env.CONFIG_PATH}/repos/*.yml`) // Changes will be an array of files that were added const added = payload.commits.map(c => { return (c.added.filter(s => { @@ -473,14 +473,14 @@ module.exports = (robot, { getRouter }, Settings = require('./lib/settings')) => return syncAllSettings(true, context, context.repo(), pull_request.head.ref) } - const repoChanges = getChangedRepoConfigName(new Glob('.github/repos/*.yml'), files, context.repo().owner) + const repoChanges = getChangedRepoConfigName(new Glob(`${env.CONFIG_PATH}/repos/*.yml`), files, context.repo().owner) if (repoChanges.length > 0) { return Promise.all(repoChanges.map(repo => { return syncSettings(true, context, repo, pull_request.head.ref) })) } - const subOrgChanges = getChangedSubOrgConfigName(new Glob('.github/suborgs/*.yml'), files, context.repo().owner) + const subOrgChanges = getChangedSubOrgConfigName(new Glob(`${env.CONFIG_PATH}/suborgs/*.yml`), files, context.repo().owner) if (subOrgChanges.length) { return Promise.all(subOrgChanges.map(suborg => { return syncSubOrgSettings(true, context, suborg, context.repo(), pull_request.head.ref) diff --git a/lib/deploymentConfig.js b/lib/deploymentConfig.js index 6cfbc460..ca9ef94a 100644 --- a/lib/deploymentConfig.js +++ b/lib/deploymentConfig.js @@ -48,6 +48,6 @@ class DeploymentConfig { constructor (nop, context, repo, config, ref, suborg) { } } -DeploymentConfig.FILE_NAME = '.github/settings.yml' +DeploymentConfig.FILE_NAME = `${env.CONFIG_PATH}/settings.yml` -module.exports = DeploymentConfig \ No newline at end of file +module.exports = DeploymentConfig diff --git a/lib/settings.js b/lib/settings.js index 4877cd72..244d7f83 100644 --- a/lib/settings.js +++ b/lib/settings.js @@ -180,7 +180,7 @@ class Settings { this.results.forEach(res => { if (res) { stats.reposProcessed[res.repo] = true - // if (res.action.additions === null && res.action.deletions === null && res.action.modifications === null) { + // if (res.action.additions === null && res.action.deletions === null && res.action.modifications === null) { // // No changes // } else if (res.type === 'ERROR') { @@ -538,7 +538,7 @@ ${this.results.reduce((x, y) => { // any pagination. They suggest to use Tree api. // https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#get-repository-content - // get .github/repos directory sha to use in the getTree api + // get /repos directory sha to use in the getTree api const repo = { owner: this.repo.owner, repo: env.ADMIN_REPO } const params = Object.assign(repo, { path: path.posix.join(CONFIG_PATH), ref: this.ref }) const githubDirectoryContentResponse = await this.github.repos.getContent(params).catch(e => { @@ -546,13 +546,13 @@ ${this.results.reduce((x, y) => { }) if (!githubDirectoryContentResponse) { - throw new Error('Error reading .github directory') + throw new Error(`Error reading ${CONFIG_PATH} directory`) } const githubDirContent = githubDirectoryContentResponse.data const repoDirInfo = githubDirContent.filter(dir => dir.name === 'repos')[0] if (!repoDirInfo) { - this.log.debug('No repos directory in the admin/.github') + this.log.debug(`No repos directory in the ${env.ADMIN_REPO}/${CONFIG_PATH}`) return [] } @@ -801,7 +801,7 @@ function prettify(obj) { return JSON.stringify(obj, null, 2).replaceAll('\n', '
').replaceAll(' ', ' ') } -Settings.FILE_NAME = '.github/' + env.SETTINGS_FILE_PATH +Settings.FILE_NAME = `${CONFIG_PATH}/${env.SETTINGS_FILE_PATH}` Settings.PLUGINS = { repository: require('./plugins/repository'), diff --git a/test/unit/lib/env.test.js b/test/unit/lib/env.test.js index 478ed804..e2b95305 100644 --- a/test/unit/lib/env.test.js +++ b/test/unit/lib/env.test.js @@ -10,6 +10,11 @@ describe('env', () => { expect(ADMIN_REPO).toEqual('admin') }) + it('loads default CONFIG_PATH if not passed', () => { + const CONFIG_PATH = envTest.CONFIG_PATH + expect(CONFIG_PATH).toEqual('.github') + }) + it('loads default SETTINGS_FILE_PATH if not passed', () => { const SETTINGS_FILE_PATH = envTest.SETTINGS_FILE_PATH expect(SETTINGS_FILE_PATH).toEqual('settings.yml') @@ -32,6 +37,7 @@ describe('env', () => { beforeAll(() => { jest.resetModules() process.env.ADMIN_REPO = '.github' + process.env.CONFIG_PATH = '.config' process.env.SETTINGS_FILE_PATH = 'safe-settings.yml' process.env.DEPLOYMENT_CONFIG_FILE = 'safe-settings-deployment.yml' process.env.CREATE_PR_COMMENT = 'false' @@ -41,6 +47,8 @@ describe('env', () => { const envTest = require('../../../lib/env') const ADMIN_REPO = envTest.ADMIN_REPO expect(ADMIN_REPO).toEqual('.github') + const CONFIG_PATH = envTest.CONFIG_PATH + 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 From bfca02891d8eb8cc62b76cdc75b45e84a76be345 Mon Sep 17 00:00:00 2001 From: Dolan Antenucci Date: Mon, 26 Feb 2024 12:53:58 -0700 Subject: [PATCH 3/4] Switching to posix.join for FILE_NAME --- lib/settings.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/settings.js b/lib/settings.js index 244d7f83..a69dfd85 100644 --- a/lib/settings.js +++ b/lib/settings.js @@ -801,7 +801,7 @@ function prettify(obj) { return JSON.stringify(obj, null, 2).replaceAll('\n', '
').replaceAll(' ', ' ') } -Settings.FILE_NAME = `${CONFIG_PATH}/${env.SETTINGS_FILE_PATH}` +Settings.FILE_NAME = path.posix.join(CONFIG_PATH, env.SETTINGS_FILE_PATH) Settings.PLUGINS = { repository: require('./plugins/repository'), From acfe811b2733494415516ef19f0c3d3f1043a4c6 Mon Sep 17 00:00:00 2001 From: Dolan Antenucci Date: Mon, 26 Feb 2024 13:26:08 -0700 Subject: [PATCH 4/4] Fix for loading env.CONFIG_PATH --- lib/deploymentConfig.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/deploymentConfig.js b/lib/deploymentConfig.js index ca9ef94a..f8fdeb27 100644 --- a/lib/deploymentConfig.js +++ b/lib/deploymentConfig.js @@ -1,5 +1,6 @@ const yaml = require('js-yaml') const fs = require('fs') +const env = require('./env') /** * Class representing a deployment config.