fix: Disable token warning on githubTokenWarn=true (#17548)

renovatebot · Aug 31, 2022 · c9d87d8 · c9d87d8
1 parent 6fa3aad
commit c9d87d8
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/lib/util/check-token.spec.ts b/lib/util/check-token.spec.ts
@@ -1,4 +1,5 @@
 import { hostRules, logger } from '../../test/util';
+import { GlobalConfig } from '../config/global';
 import { GithubReleasesDatasource } from '../modules/datasource/github-releases';
 import { GithubTagsDatasource } from '../modules/datasource/github-tags';
 import type { PackageFile } from '../modules/manager/types';
@@ -11,6 +12,7 @@ describe('util/check-token', () => {
   beforeEach(() => {
     jest.resetAllMocks();
     memCache.reset();
+    GlobalConfig.set({ githubTokenWarn: true });
   });
 
   it('does nothing if data is empty', () => {
@@ -31,6 +33,20 @@ describe('util/check-token', () => {
     expect(logger.logger.warn).not.toHaveBeenCalled();
   });
 
+  it('returns early if token warnings are disabled', () => {
+    GlobalConfig.set({ githubTokenWarn: false });
+    hostRules.find.mockReturnValueOnce({});
+    checkGithubToken({});
+    expect(hostRules.find).toHaveBeenCalledWith({
+      hostType: 'github',
+      url: 'https://api.github.com',
+    });
+    expect(logger.logger.trace).toHaveBeenCalledWith(
+      'GitHub token warning is disabled'
+    );
+    expect(logger.logger.warn).not.toHaveBeenCalled();
+  });
+
   it('does not warn if there is dependencies with GitHub sourceUrl', () => {
     hostRules.find.mockReturnValueOnce({});
     checkGithubToken({

diff --git a/lib/util/check-token.ts b/lib/util/check-token.ts
@@ -1,3 +1,4 @@
+import { GlobalConfig } from '../config/global';
 import { PlatformId } from '../constants';
 import { logger } from '../logger';
 import { GithubReleasesDatasource } from '../modules/datasource/github-releases';
@@ -19,13 +20,19 @@ export function checkGithubToken(
     return;
   }
 
+  if (!GlobalConfig.get('githubTokenWarn')) {
+    logger.trace('GitHub token warning is disabled');
+    return;
+  }
+
   const githubDeps: string[] = [];
   for (const files of Object.values(packageFiles ?? {})) {
     for (const file of files ?? []) {
       for (const dep of file.deps ?? []) {
         if (
-          dep.datasource === GithubTagsDatasource.id ||
-          dep.datasource === GithubReleasesDatasource.id
+          !dep.skipReason &&
+          (dep.datasource === GithubTagsDatasource.id ||
+            dep.datasource === GithubReleasesDatasource.id)
         ) {
           dep.skipReason = 'github-token-required';
           if (dep.depName) {

diff --git a/lib/workers/repository/update/pr/changelog/source-github.ts b/lib/workers/repository/update/pr/changelog/source-github.ts
@@ -59,7 +59,7 @@ export async function getChangeLogJSON(
   // istanbul ignore if
   if (!token) {
     if (host!.endsWith('.github.com') || host === 'github.com') {
-      if (!GlobalConfig.get().githubTokenWarn) {
+      if (!GlobalConfig.get('githubTokenWarn')) {
         logger.debug(
           { manager, depName, sourceUrl },
           'GitHub token warning has been suppressed. Skipping release notes retrieval'