@graphql-inspector/action 6.0.0 → 6.1.0

package/cjs/action/helpers/types.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CheckConclusion = exports.CheckStatus = exports.AnnotationLevel = void 0;
+exports.CheckConclusion = exports.CheckStatus = exports.AnnotationLevel = exports.AnnotationFilterLevel = void 0;
+var AnnotationFilterLevel;
+(function (AnnotationFilterLevel) {
+    AnnotationFilterLevel["All"] = "all";
+    AnnotationFilterLevel["Dangerous"] = "dangerous";
+    AnnotationFilterLevel["Breaking"] = "breaking";
+})(AnnotationFilterLevel || (exports.AnnotationFilterLevel = AnnotationFilterLevel = {}));
 var AnnotationLevel;
 (function (AnnotationLevel) {
     AnnotationLevel["Failure"] = "failure";

package/cjs/action/src/run.js

@@ -31,6 +31,10 @@ async function run() {
     }
     const useMerge = (0, utils_js_2.castToBoolean)(core.getInput('experimental_merge'), true);
     const useAnnotations = (0, utils_js_2.castToBoolean)(core.getInput('annotations'));
+    const annotationLevel = core.getInput('annotation-level') || types_js_1.AnnotationFilterLevel.All;
+    if (!(0, utils_js_2.isAnnotationFilterLevel)(annotationLevel)) {
+        return core.setFailed(`Invalid annotation-level. Expected one of: ${Object.values(types_js_1.AnnotationFilterLevel).join(', ')}.`);
+    }
     const failOnBreaking = (0, utils_js_2.castToBoolean)(core.getInput('fail-on-breaking'));
     const endpoint = core.getInput('endpoint');
     const approveLabel = core.getInput('approve-label') || 'approved-breaking-change';
@@ -166,6 +170,11 @@ async function run() {
         core.info(`Anotations are disabled. Skipping annotations...`);
         annotations = [];
     }
+    else if (annotationLevel !== types_js_1.AnnotationFilterLevel.All) {
+        annotations = annotations.filter(annotation => annotationLevel === types_js_1.AnnotationFilterLevel.Breaking
+            ? annotation.annotation_level === types_js_1.AnnotationLevel.Failure
+            : annotation.annotation_level !== types_js_1.AnnotationLevel.Notice);
+    }
     const summary = (0, utils_js_1.createSummary)(changes, 100, false);
     const title = conclusion === types_js_1.CheckConclusion.Failure
         ? 'Something is wrong with your schema'

package/cjs/action/src/utils.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.batch = batch;
 exports.castToBoolean = castToBoolean;
+exports.isAnnotationFilterLevel = isAnnotationFilterLevel;
 exports.getInputAsArray = getInputAsArray;
 exports.resolveRule = resolveRule;
 const tslib_1 = require("tslib");
@@ -9,6 +10,8 @@ const fs_1 = require("fs");
 const core = tslib_1.__importStar(require("@actions/core"));
 const commands_1 = require("@graphql-inspector/commands");
 const core_1 = require("@graphql-inspector/core");
+const types_js_1 = require("../helpers/types.js");
+const annotationFilterLevels = Object.values(types_js_1.AnnotationFilterLevel);
 function batch(items, limit) {
     const batches = [];
     const batchesNum = Math.ceil(items.length / limit);
@@ -38,6 +41,9 @@ function castToBoolean(value, defaultValue) {
     }
     return true;
 }
+function isAnnotationFilterLevel(value) {
+    return annotationFilterLevels.includes(value);
+}
 function getInputAsArray(name, options) {
     return core
         .getInput(name, options)

package/cjs/run.js

@@ -31,6 +31,10 @@ async function run() {
     }
     const useMerge = (0, utils_js_2.castToBoolean)(core.getInput('experimental_merge'), true);
     const useAnnotations = (0, utils_js_2.castToBoolean)(core.getInput('annotations'));
+    const annotationLevel = core.getInput('annotation-level') || types_js_1.AnnotationFilterLevel.All;
+    if (!(0, utils_js_2.isAnnotationFilterLevel)(annotationLevel)) {
+        return core.setFailed(`Invalid annotation-level. Expected one of: ${Object.values(types_js_1.AnnotationFilterLevel).join(', ')}.`);
+    }
     const failOnBreaking = (0, utils_js_2.castToBoolean)(core.getInput('fail-on-breaking'));
     const endpoint = core.getInput('endpoint');
     const approveLabel = core.getInput('approve-label') || 'approved-breaking-change';
@@ -166,6 +170,11 @@ async function run() {
         core.info(`Anotations are disabled. Skipping annotations...`);
         annotations = [];
     }
+    else if (annotationLevel !== types_js_1.AnnotationFilterLevel.All) {
+        annotations = annotations.filter(annotation => annotationLevel === types_js_1.AnnotationFilterLevel.Breaking
+            ? annotation.annotation_level === types_js_1.AnnotationLevel.Failure
+            : annotation.annotation_level !== types_js_1.AnnotationLevel.Notice);
+    }
     const summary = (0, utils_js_1.createSummary)(changes, 100, false);
     const title = conclusion === types_js_1.CheckConclusion.Failure
         ? 'Something is wrong with your schema'

package/cjs/utils.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.batch = batch;
 exports.castToBoolean = castToBoolean;
+exports.isAnnotationFilterLevel = isAnnotationFilterLevel;
 exports.getInputAsArray = getInputAsArray;
 exports.resolveRule = resolveRule;
 const tslib_1 = require("tslib");
@@ -9,6 +10,8 @@ const fs_1 = require("fs");
 const core = tslib_1.__importStar(require("@actions/core"));
 const commands_1 = require("@graphql-inspector/commands");
 const core_1 = require("@graphql-inspector/core");
+const types_js_1 = require("../helpers/types.js");
+const annotationFilterLevels = Object.values(types_js_1.AnnotationFilterLevel);
 function batch(items, limit) {
     const batches = [];
     const batchesNum = Math.ceil(items.length / limit);
@@ -38,6 +41,9 @@ function castToBoolean(value, defaultValue) {
     }
     return true;
 }
+function isAnnotationFilterLevel(value) {
+    return annotationFilterLevels.includes(value);
+}
 function getInputAsArray(name, options) {
     return core
         .getInput(name, options)

package/esm/action/helpers/types.js

@@ -1,3 +1,9 @@
+export var AnnotationFilterLevel;
+(function (AnnotationFilterLevel) {
+    AnnotationFilterLevel["All"] = "all";
+    AnnotationFilterLevel["Dangerous"] = "dangerous";
+    AnnotationFilterLevel["Breaking"] = "breaking";
+})(AnnotationFilterLevel || (AnnotationFilterLevel = {}));
 export var AnnotationLevel;
 (function (AnnotationLevel) {
     AnnotationLevel["Failure"] = "failure";

package/esm/action/src/run.js

@@ -5,12 +5,12 @@ import * as github from '@actions/github';
 import { diff } from '../helpers/diff.js';
 import { printSchemaFromEndpoint } from '../helpers/loaders.js';
 import { produceSchema } from '../helpers/schema.js';
-import { CheckConclusion } from '../helpers/types.js';
+import { AnnotationFilterLevel, AnnotationLevel, CheckConclusion } from '../helpers/types.js';
 import { createSummary } from '../helpers/utils.js';
 import { updateCheckRun } from './checks.js';
 import { fileLoader } from './files.js';
 import { getAssociatedPullRequest, getCurrentCommitSha } from './git.js';
-import { castToBoolean, getInputAsArray, resolveRule } from './utils.js';
+import { castToBoolean, getInputAsArray, isAnnotationFilterLevel, resolveRule } from './utils.js';
 const CHECK_NAME = 'GraphQL Inspector';
 export async function run() {
     core.info(`GraphQL Inspector started`);
@@ -27,6 +27,10 @@ export async function run() {
     }
     const useMerge = castToBoolean(core.getInput('experimental_merge'), true);
     const useAnnotations = castToBoolean(core.getInput('annotations'));
+    const annotationLevel = core.getInput('annotation-level') || AnnotationFilterLevel.All;
+    if (!isAnnotationFilterLevel(annotationLevel)) {
+        return core.setFailed(`Invalid annotation-level. Expected one of: ${Object.values(AnnotationFilterLevel).join(', ')}.`);
+    }
     const failOnBreaking = castToBoolean(core.getInput('fail-on-breaking'));
     const endpoint = core.getInput('endpoint');
     const approveLabel = core.getInput('approve-label') || 'approved-breaking-change';
@@ -162,6 +166,11 @@ export async function run() {
         core.info(`Anotations are disabled. Skipping annotations...`);
         annotations = [];
     }
+    else if (annotationLevel !== AnnotationFilterLevel.All) {
+        annotations = annotations.filter(annotation => annotationLevel === AnnotationFilterLevel.Breaking
+            ? annotation.annotation_level === AnnotationLevel.Failure
+            : annotation.annotation_level !== AnnotationLevel.Notice);
+    }
     const summary = createSummary(changes, 100, false);
     const title = conclusion === CheckConclusion.Failure
         ? 'Something is wrong with your schema'

package/esm/action/src/utils.js

@@ -2,6 +2,8 @@ import { existsSync } from 'fs';
 import * as core from '@actions/core';
 import { ensureAbsolute } from '@graphql-inspector/commands';
 import { DiffRule } from '@graphql-inspector/core';
+import { AnnotationFilterLevel } from '../helpers/types.js';
+const annotationFilterLevels = Object.values(AnnotationFilterLevel);
 export function batch(items, limit) {
     const batches = [];
     const batchesNum = Math.ceil(items.length / limit);
@@ -31,6 +33,9 @@ export function castToBoolean(value, defaultValue) {
     }
     return true;
 }
+export function isAnnotationFilterLevel(value) {
+    return annotationFilterLevels.includes(value);
+}
 export function getInputAsArray(name, options) {
     return core
         .getInput(name, options)

package/esm/run.js

@@ -5,12 +5,12 @@ import * as github from '@actions/github';
 import { diff } from '../helpers/diff.js';
 import { printSchemaFromEndpoint } from '../helpers/loaders.js';
 import { produceSchema } from '../helpers/schema.js';
-import { CheckConclusion } from '../helpers/types.js';
+import { AnnotationFilterLevel, AnnotationLevel, CheckConclusion } from '../helpers/types.js';
 import { createSummary } from '../helpers/utils.js';
 import { updateCheckRun } from './checks.js';
 import { fileLoader } from './files.js';
 import { getAssociatedPullRequest, getCurrentCommitSha } from './git.js';
-import { castToBoolean, getInputAsArray, resolveRule } from './utils.js';
+import { castToBoolean, getInputAsArray, isAnnotationFilterLevel, resolveRule } from './utils.js';
 const CHECK_NAME = 'GraphQL Inspector';
 export async function run() {
     core.info(`GraphQL Inspector started`);
@@ -27,6 +27,10 @@ export async function run() {
     }
     const useMerge = castToBoolean(core.getInput('experimental_merge'), true);
     const useAnnotations = castToBoolean(core.getInput('annotations'));
+    const annotationLevel = core.getInput('annotation-level') || AnnotationFilterLevel.All;
+    if (!isAnnotationFilterLevel(annotationLevel)) {
+        return core.setFailed(`Invalid annotation-level. Expected one of: ${Object.values(AnnotationFilterLevel).join(', ')}.`);
+    }
     const failOnBreaking = castToBoolean(core.getInput('fail-on-breaking'));
     const endpoint = core.getInput('endpoint');
     const approveLabel = core.getInput('approve-label') || 'approved-breaking-change';
@@ -162,6 +166,11 @@ export async function run() {
         core.info(`Anotations are disabled. Skipping annotations...`);
         annotations = [];
     }
+    else if (annotationLevel !== AnnotationFilterLevel.All) {
+        annotations = annotations.filter(annotation => annotationLevel === AnnotationFilterLevel.Breaking
+            ? annotation.annotation_level === AnnotationLevel.Failure
+            : annotation.annotation_level !== AnnotationLevel.Notice);
+    }
     const summary = createSummary(changes, 100, false);
     const title = conclusion === CheckConclusion.Failure
         ? 'Something is wrong with your schema'

package/esm/utils.js

@@ -2,6 +2,8 @@ import { existsSync } from 'fs';
 import * as core from '@actions/core';
 import { ensureAbsolute } from '@graphql-inspector/commands';
 import { DiffRule } from '@graphql-inspector/core';
+import { AnnotationFilterLevel } from '../helpers/types.js';
+const annotationFilterLevels = Object.values(AnnotationFilterLevel);
 export function batch(items, limit) {
     const batches = [];
     const batchesNum = Math.ceil(items.length / limit);
@@ -31,6 +33,9 @@ export function castToBoolean(value, defaultValue) {
     }
     return true;
 }
+export function isAnnotationFilterLevel(value) {
+    return annotationFilterLevels.includes(value);
+}
 export function getInputAsArray(name, options) {
     return core
         .getInput(name, options)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-inspector/action",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "GraphQL Inspector functionality for GitHub Actions",
   "sideEffects": false,
   "dependencies": {
@@ -15,7 +15,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "graphql-hive/graphql-inspector",
+    "url": "https://github.com/graphql-hive/graphql-inspector",
     "directory": "packages/action"
   },
   "keywords": [

package/typings/action/helpers/types.d.cts

@@ -16,6 +16,11 @@ export interface Annotation {
     start_column?: number;
     end_column?: number;
 }
+export declare enum AnnotationFilterLevel {
+    All = "all",
+    Dangerous = "dangerous",
+    Breaking = "breaking"
+}
 export declare enum AnnotationLevel {
     Failure = "failure",
     Warning = "warning",

package/typings/action/helpers/types.d.ts

@@ -16,6 +16,11 @@ export interface Annotation {
     start_column?: number;
     end_column?: number;
 }
+export declare enum AnnotationFilterLevel {
+    All = "all",
+    Dangerous = "dangerous",
+    Breaking = "breaking"
+}
 export declare enum AnnotationLevel {
     Failure = "failure",
     Warning = "warning",

package/typings/action/src/utils.d.cts

@@ -1,9 +1,11 @@
 import * as core from '@actions/core';
 import { Rule } from '@graphql-inspector/core';
+import { AnnotationFilterLevel } from '../helpers/types.cjs';
 export declare function batch<T>(items: T[], limit: number): T[][];
 /**
  * Treats non-falsy value as true
  */
 export declare function castToBoolean(value: string | boolean, defaultValue?: boolean): boolean;
+export declare function isAnnotationFilterLevel(value: string): value is AnnotationFilterLevel;
 export declare function getInputAsArray(name: string, options?: core.InputOptions): string[];
 export declare function resolveRule(name: string): Rule | undefined;

package/typings/action/src/utils.d.ts

@@ -1,9 +1,11 @@
 import * as core from '@actions/core';
 import { Rule } from '@graphql-inspector/core';
+import { AnnotationFilterLevel } from '../helpers/types.js';
 export declare function batch<T>(items: T[], limit: number): T[][];
 /**
  * Treats non-falsy value as true
  */
 export declare function castToBoolean(value: string | boolean, defaultValue?: boolean): boolean;
+export declare function isAnnotationFilterLevel(value: string): value is AnnotationFilterLevel;
 export declare function getInputAsArray(name: string, options?: core.InputOptions): string[];
 export declare function resolveRule(name: string): Rule | undefined;

package/typings/utils.d.cts

@@ -1,9 +1,11 @@
 import * as core from '@actions/core';
 import { Rule } from '@graphql-inspector/core';
+import { AnnotationFilterLevel } from '../helpers/types.cjs';
 export declare function batch<T>(items: T[], limit: number): T[][];
 /**
  * Treats non-falsy value as true
  */
 export declare function castToBoolean(value: string | boolean, defaultValue?: boolean): boolean;
+export declare function isAnnotationFilterLevel(value: string): value is AnnotationFilterLevel;
 export declare function getInputAsArray(name: string, options?: core.InputOptions): string[];
 export declare function resolveRule(name: string): Rule | undefined;

package/typings/utils.d.ts

@@ -1,9 +1,11 @@
 import * as core from '@actions/core';
 import { Rule } from '@graphql-inspector/core';
+import { AnnotationFilterLevel } from '../helpers/types.js';
 export declare function batch<T>(items: T[], limit: number): T[][];
 /**
  * Treats non-falsy value as true
  */
 export declare function castToBoolean(value: string | boolean, defaultValue?: boolean): boolean;
+export declare function isAnnotationFilterLevel(value: string): value is AnnotationFilterLevel;
 export declare function getInputAsArray(name: string, options?: core.InputOptions): string[];
 export declare function resolveRule(name: string): Rule | undefined;