@graphql-inspector/action 6.1.0 → 6.2.0

package/cjs/action/helpers/utils.js

@@ -5,6 +5,7 @@ exports.quotesTransformer = quotesTransformer;
 exports.slackCoderize = slackCoderize;
 exports.discordCoderize = discordCoderize;
 exports.filterChangesByLevel = filterChangesByLevel;
+exports.splitChangesIntoGroups = splitChangesIntoGroups;
 exports.createSummary = createSummary;
 exports.isNil = isNil;
 exports.parseEndpoint = parseEndpoint;
@@ -31,16 +32,21 @@ function discordCoderize(msg) {
 function filterChangesByLevel(level) {
     return (change) => change.criticality.level === level;
 }
+function splitChangesIntoGroups(changes) {
+    return {
+        breaking: changes.filter(filterChangesByLevel(core_1.CriticalityLevel.Breaking)),
+        dangerous: changes.filter(filterChangesByLevel(core_1.CriticalityLevel.Dangerous)),
+        safe: changes.filter(filterChangesByLevel(core_1.CriticalityLevel.NonBreaking)),
+    };
+}
 function createSummary(changes, summaryLimit, isLegacyConfig = false) {
-    const breakingChanges = changes.filter(filterChangesByLevel(core_1.CriticalityLevel.Breaking));
-    const dangerousChanges = changes.filter(filterChangesByLevel(core_1.CriticalityLevel.Dangerous));
-    const safeChanges = changes.filter(filterChangesByLevel(core_1.CriticalityLevel.NonBreaking));
+    const groupedChanges = splitChangesIntoGroups(changes);
     const summary = [
         `# Found ${changes.length} change${changes.length > 1 ? 's' : ''}`,
         '',
-        `Breaking: ${breakingChanges.length}`,
-        `Dangerous: ${dangerousChanges.length}`,
-        `Safe: ${safeChanges.length}`,
+        `Breaking: ${groupedChanges.breaking.length}`,
+        `Dangerous: ${groupedChanges.dangerous.length}`,
+        `Safe: ${groupedChanges.safe.length}`,
     ];
     if (isLegacyConfig) {
         summary.push([
@@ -63,14 +69,14 @@ function createSummary(changes, summaryLimit, isLegacyConfig = false) {
         }
         summaryLimit -= changes.length;
     }
-    if (breakingChanges.length) {
-        addChangesToSummary('Breaking', breakingChanges);
+    if (groupedChanges.breaking.length) {
+        addChangesToSummary('Breaking', groupedChanges.breaking);
     }
-    if (dangerousChanges.length) {
-        addChangesToSummary('Dangerous', dangerousChanges);
+    if (groupedChanges.dangerous.length) {
+        addChangesToSummary('Dangerous', groupedChanges.dangerous);
     }
-    if (safeChanges.length) {
-        addChangesToSummary('Safe', safeChanges);
+    if (groupedChanges.safe.length) {
+        addChangesToSummary('Safe', groupedChanges.safe);
     }
     summary.push([
         '',

package/cjs/action/src/run.js

@@ -40,21 +40,30 @@ async function run() {
     const approveLabel = core.getInput('approve-label') || 'approved-breaking-change';
     const rulesList = (0, utils_js_2.getInputAsArray)('rules') || [];
     const onUsage = core.getInput('onUsage');
+    const createActionCheck = (0, utils_js_2.castToBoolean)(core.getInput('create-action-check'), true);
     const octokit = github.getOctokit(token);
     // repo
     const { owner, repo } = github.context.repo;
     // pull request
     const pullRequest = await (0, git_js_1.getAssociatedPullRequest)(octokit, commitSha);
-    core.info(`Creating a check named "${checkName}"`);
-    const check = await octokit.rest.checks.create({
-        owner,
-        repo,
-        name: checkName,
-        head_sha: commitSha,
-        status: 'in_progress',
-    });
-    const checkId = check.data.id;
-    core.info(`Check ID: ${checkId}`);
+    let checkId = null;
+    let seeCheckURL = '';
+    if (createActionCheck) {
+        core.info(`Creating a check named "${checkName}"`);
+        const check = await octokit.rest.checks.create({
+            owner,
+            repo,
+            name: checkName,
+            head_sha: commitSha,
+            status: 'in_progress',
+        });
+        checkId = check.data.id;
+        seeCheckURL = ' For more info see: ' + check.data.html_url;
+        core.info(`Check ID: ${checkId}`);
+    }
+    else {
+        core.info('Skipping check creation - disabled by input option');
+    }
     const schemaPointer = core.getInput('schema', { required: true });
     const loadFile = (0, files_js_1.fileLoader)({
         octokit,
@@ -157,8 +166,11 @@ async function run() {
     let conclusion = action.conclusion;
     let annotations = action.annotations || [];
     const changes = action.changes || [];
+    const groupedChanges = (0, utils_js_1.splitChangesIntoGroups)(changes);
     core.setOutput('changes', String(changes.length || 0));
-    core.info(`Changes: ${changes.length || 0}`);
+    core.setOutput('breaking-changes', groupedChanges.breaking.map(c => c.message));
+    core.setOutput('dangerous-changes', groupedChanges.dangerous.map(c => c.message));
+    core.setOutput('safe-changes', groupedChanges.safe.map(c => c.message));
     const hasApprovedBreakingChangeLabel = pullRequest?.labels?.some((label) => label.name === approveLabel);
     // Force Success when failOnBreaking is disabled
     if ((failOnBreaking === false || hasApprovedBreakingChangeLabel) &&
@@ -166,6 +178,18 @@ async function run() {
         core.info('FailOnBreaking disabled. Forcing SUCCESS');
         conclusion = types_js_1.CheckConclusion.Success;
     }
+    const title = conclusion === types_js_1.CheckConclusion.Failure
+        ? 'Something is wrong with your schema.' + seeCheckURL // add Check URL to navigate users to Check from action.
+        : 'Everything looks good';
+    core.info(`Conclusion: ${conclusion}`);
+    // Action Check is disabled
+    if (checkId === null) {
+        core.info('Github Action Check is disabled, use outputs to determine errors');
+        if (conclusion === types_js_1.CheckConclusion.Failure) {
+            core.setFailed(conclusion);
+        }
+        return;
+    }
     if (useAnnotations === false || isNewSchemaUrl) {
         core.info(`Anotations are disabled. Skipping annotations...`);
         annotations = [];
@@ -176,10 +200,6 @@ async function run() {
             : 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'
-        : 'Everything looks good';
-    core.info(`Conclusion: ${conclusion}`);
     try {
         return await (0, checks_js_1.updateCheckRun)(octokit, checkId, {
             conclusion,

package/cjs/run.js

@@ -40,21 +40,30 @@ async function run() {
     const approveLabel = core.getInput('approve-label') || 'approved-breaking-change';
     const rulesList = (0, utils_js_2.getInputAsArray)('rules') || [];
     const onUsage = core.getInput('onUsage');
+    const createActionCheck = (0, utils_js_2.castToBoolean)(core.getInput('create-action-check'), true);
     const octokit = github.getOctokit(token);
     // repo
     const { owner, repo } = github.context.repo;
     // pull request
     const pullRequest = await (0, git_js_1.getAssociatedPullRequest)(octokit, commitSha);
-    core.info(`Creating a check named "${checkName}"`);
-    const check = await octokit.rest.checks.create({
-        owner,
-        repo,
-        name: checkName,
-        head_sha: commitSha,
-        status: 'in_progress',
-    });
-    const checkId = check.data.id;
-    core.info(`Check ID: ${checkId}`);
+    let checkId = null;
+    let seeCheckURL = '';
+    if (createActionCheck) {
+        core.info(`Creating a check named "${checkName}"`);
+        const check = await octokit.rest.checks.create({
+            owner,
+            repo,
+            name: checkName,
+            head_sha: commitSha,
+            status: 'in_progress',
+        });
+        checkId = check.data.id;
+        seeCheckURL = ' For more info see: ' + check.data.html_url;
+        core.info(`Check ID: ${checkId}`);
+    }
+    else {
+        core.info('Skipping check creation - disabled by input option');
+    }
     const schemaPointer = core.getInput('schema', { required: true });
     const loadFile = (0, files_js_1.fileLoader)({
         octokit,
@@ -157,8 +166,11 @@ async function run() {
     let conclusion = action.conclusion;
     let annotations = action.annotations || [];
     const changes = action.changes || [];
+    const groupedChanges = (0, utils_js_1.splitChangesIntoGroups)(changes);
     core.setOutput('changes', String(changes.length || 0));
-    core.info(`Changes: ${changes.length || 0}`);
+    core.setOutput('breaking-changes', groupedChanges.breaking.map(c => c.message));
+    core.setOutput('dangerous-changes', groupedChanges.dangerous.map(c => c.message));
+    core.setOutput('safe-changes', groupedChanges.safe.map(c => c.message));
     const hasApprovedBreakingChangeLabel = pullRequest?.labels?.some((label) => label.name === approveLabel);
     // Force Success when failOnBreaking is disabled
     if ((failOnBreaking === false || hasApprovedBreakingChangeLabel) &&
@@ -166,6 +178,18 @@ async function run() {
         core.info('FailOnBreaking disabled. Forcing SUCCESS');
         conclusion = types_js_1.CheckConclusion.Success;
     }
+    const title = conclusion === types_js_1.CheckConclusion.Failure
+        ? 'Something is wrong with your schema.' + seeCheckURL // add Check URL to navigate users to Check from action.
+        : 'Everything looks good';
+    core.info(`Conclusion: ${conclusion}`);
+    // Action Check is disabled
+    if (checkId === null) {
+        core.info('Github Action Check is disabled, use outputs to determine errors');
+        if (conclusion === types_js_1.CheckConclusion.Failure) {
+            core.setFailed(conclusion);
+        }
+        return;
+    }
     if (useAnnotations === false || isNewSchemaUrl) {
         core.info(`Anotations are disabled. Skipping annotations...`);
         annotations = [];
@@ -176,10 +200,6 @@ async function run() {
             : 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'
-        : 'Everything looks good';
-    core.info(`Conclusion: ${conclusion}`);
     try {
         return await (0, checks_js_1.updateCheckRun)(octokit, checkId, {
             conclusion,

package/esm/action/helpers/utils.js

@@ -19,16 +19,21 @@ export function discordCoderize(msg) {
 export function filterChangesByLevel(level) {
     return (change) => change.criticality.level === level;
 }
+export function splitChangesIntoGroups(changes) {
+    return {
+        breaking: changes.filter(filterChangesByLevel(CriticalityLevel.Breaking)),
+        dangerous: changes.filter(filterChangesByLevel(CriticalityLevel.Dangerous)),
+        safe: changes.filter(filterChangesByLevel(CriticalityLevel.NonBreaking)),
+    };
+}
 export function createSummary(changes, summaryLimit, isLegacyConfig = false) {
-    const breakingChanges = changes.filter(filterChangesByLevel(CriticalityLevel.Breaking));
-    const dangerousChanges = changes.filter(filterChangesByLevel(CriticalityLevel.Dangerous));
-    const safeChanges = changes.filter(filterChangesByLevel(CriticalityLevel.NonBreaking));
+    const groupedChanges = splitChangesIntoGroups(changes);
     const summary = [
         `# Found ${changes.length} change${changes.length > 1 ? 's' : ''}`,
         '',
-        `Breaking: ${breakingChanges.length}`,
-        `Dangerous: ${dangerousChanges.length}`,
-        `Safe: ${safeChanges.length}`,
+        `Breaking: ${groupedChanges.breaking.length}`,
+        `Dangerous: ${groupedChanges.dangerous.length}`,
+        `Safe: ${groupedChanges.safe.length}`,
     ];
     if (isLegacyConfig) {
         summary.push([
@@ -51,14 +56,14 @@ export function createSummary(changes, summaryLimit, isLegacyConfig = false) {
         }
         summaryLimit -= changes.length;
     }
-    if (breakingChanges.length) {
-        addChangesToSummary('Breaking', breakingChanges);
+    if (groupedChanges.breaking.length) {
+        addChangesToSummary('Breaking', groupedChanges.breaking);
     }
-    if (dangerousChanges.length) {
-        addChangesToSummary('Dangerous', dangerousChanges);
+    if (groupedChanges.dangerous.length) {
+        addChangesToSummary('Dangerous', groupedChanges.dangerous);
     }
-    if (safeChanges.length) {
-        addChangesToSummary('Safe', safeChanges);
+    if (groupedChanges.safe.length) {
+        addChangesToSummary('Safe', groupedChanges.safe);
     }
     summary.push([
         '',

package/esm/action/src/run.js

@@ -6,7 +6,7 @@ import { diff } from '../helpers/diff.js';
 import { printSchemaFromEndpoint } from '../helpers/loaders.js';
 import { produceSchema } from '../helpers/schema.js';
 import { AnnotationFilterLevel, AnnotationLevel, CheckConclusion } from '../helpers/types.js';
-import { createSummary } from '../helpers/utils.js';
+import { createSummary, splitChangesIntoGroups } from '../helpers/utils.js';
 import { updateCheckRun } from './checks.js';
 import { fileLoader } from './files.js';
 import { getAssociatedPullRequest, getCurrentCommitSha } from './git.js';
@@ -36,21 +36,30 @@ export async function run() {
     const approveLabel = core.getInput('approve-label') || 'approved-breaking-change';
     const rulesList = getInputAsArray('rules') || [];
     const onUsage = core.getInput('onUsage');
+    const createActionCheck = castToBoolean(core.getInput('create-action-check'), true);
     const octokit = github.getOctokit(token);
     // repo
     const { owner, repo } = github.context.repo;
     // pull request
     const pullRequest = await getAssociatedPullRequest(octokit, commitSha);
-    core.info(`Creating a check named "${checkName}"`);
-    const check = await octokit.rest.checks.create({
-        owner,
-        repo,
-        name: checkName,
-        head_sha: commitSha,
-        status: 'in_progress',
-    });
-    const checkId = check.data.id;
-    core.info(`Check ID: ${checkId}`);
+    let checkId = null;
+    let seeCheckURL = '';
+    if (createActionCheck) {
+        core.info(`Creating a check named "${checkName}"`);
+        const check = await octokit.rest.checks.create({
+            owner,
+            repo,
+            name: checkName,
+            head_sha: commitSha,
+            status: 'in_progress',
+        });
+        checkId = check.data.id;
+        seeCheckURL = ' For more info see: ' + check.data.html_url;
+        core.info(`Check ID: ${checkId}`);
+    }
+    else {
+        core.info('Skipping check creation - disabled by input option');
+    }
     const schemaPointer = core.getInput('schema', { required: true });
     const loadFile = fileLoader({
         octokit,
@@ -153,8 +162,11 @@ export async function run() {
     let conclusion = action.conclusion;
     let annotations = action.annotations || [];
     const changes = action.changes || [];
+    const groupedChanges = splitChangesIntoGroups(changes);
     core.setOutput('changes', String(changes.length || 0));
-    core.info(`Changes: ${changes.length || 0}`);
+    core.setOutput('breaking-changes', groupedChanges.breaking.map(c => c.message));
+    core.setOutput('dangerous-changes', groupedChanges.dangerous.map(c => c.message));
+    core.setOutput('safe-changes', groupedChanges.safe.map(c => c.message));
     const hasApprovedBreakingChangeLabel = pullRequest?.labels?.some((label) => label.name === approveLabel);
     // Force Success when failOnBreaking is disabled
     if ((failOnBreaking === false || hasApprovedBreakingChangeLabel) &&
@@ -162,6 +174,18 @@ export async function run() {
         core.info('FailOnBreaking disabled. Forcing SUCCESS');
         conclusion = CheckConclusion.Success;
     }
+    const title = conclusion === CheckConclusion.Failure
+        ? 'Something is wrong with your schema.' + seeCheckURL // add Check URL to navigate users to Check from action.
+        : 'Everything looks good';
+    core.info(`Conclusion: ${conclusion}`);
+    // Action Check is disabled
+    if (checkId === null) {
+        core.info('Github Action Check is disabled, use outputs to determine errors');
+        if (conclusion === CheckConclusion.Failure) {
+            core.setFailed(conclusion);
+        }
+        return;
+    }
     if (useAnnotations === false || isNewSchemaUrl) {
         core.info(`Anotations are disabled. Skipping annotations...`);
         annotations = [];
@@ -172,10 +196,6 @@ export async function run() {
             : annotation.annotation_level !== AnnotationLevel.Notice);
     }
     const summary = createSummary(changes, 100, false);
-    const title = conclusion === CheckConclusion.Failure
-        ? 'Something is wrong with your schema'
-        : 'Everything looks good';
-    core.info(`Conclusion: ${conclusion}`);
     try {
         return await updateCheckRun(octokit, checkId, {
             conclusion,

package/esm/run.js

@@ -6,7 +6,7 @@ import { diff } from '../helpers/diff.js';
 import { printSchemaFromEndpoint } from '../helpers/loaders.js';
 import { produceSchema } from '../helpers/schema.js';
 import { AnnotationFilterLevel, AnnotationLevel, CheckConclusion } from '../helpers/types.js';
-import { createSummary } from '../helpers/utils.js';
+import { createSummary, splitChangesIntoGroups } from '../helpers/utils.js';
 import { updateCheckRun } from './checks.js';
 import { fileLoader } from './files.js';
 import { getAssociatedPullRequest, getCurrentCommitSha } from './git.js';
@@ -36,21 +36,30 @@ export async function run() {
     const approveLabel = core.getInput('approve-label') || 'approved-breaking-change';
     const rulesList = getInputAsArray('rules') || [];
     const onUsage = core.getInput('onUsage');
+    const createActionCheck = castToBoolean(core.getInput('create-action-check'), true);
     const octokit = github.getOctokit(token);
     // repo
     const { owner, repo } = github.context.repo;
     // pull request
     const pullRequest = await getAssociatedPullRequest(octokit, commitSha);
-    core.info(`Creating a check named "${checkName}"`);
-    const check = await octokit.rest.checks.create({
-        owner,
-        repo,
-        name: checkName,
-        head_sha: commitSha,
-        status: 'in_progress',
-    });
-    const checkId = check.data.id;
-    core.info(`Check ID: ${checkId}`);
+    let checkId = null;
+    let seeCheckURL = '';
+    if (createActionCheck) {
+        core.info(`Creating a check named "${checkName}"`);
+        const check = await octokit.rest.checks.create({
+            owner,
+            repo,
+            name: checkName,
+            head_sha: commitSha,
+            status: 'in_progress',
+        });
+        checkId = check.data.id;
+        seeCheckURL = ' For more info see: ' + check.data.html_url;
+        core.info(`Check ID: ${checkId}`);
+    }
+    else {
+        core.info('Skipping check creation - disabled by input option');
+    }
     const schemaPointer = core.getInput('schema', { required: true });
     const loadFile = fileLoader({
         octokit,
@@ -153,8 +162,11 @@ export async function run() {
     let conclusion = action.conclusion;
     let annotations = action.annotations || [];
     const changes = action.changes || [];
+    const groupedChanges = splitChangesIntoGroups(changes);
     core.setOutput('changes', String(changes.length || 0));
-    core.info(`Changes: ${changes.length || 0}`);
+    core.setOutput('breaking-changes', groupedChanges.breaking.map(c => c.message));
+    core.setOutput('dangerous-changes', groupedChanges.dangerous.map(c => c.message));
+    core.setOutput('safe-changes', groupedChanges.safe.map(c => c.message));
     const hasApprovedBreakingChangeLabel = pullRequest?.labels?.some((label) => label.name === approveLabel);
     // Force Success when failOnBreaking is disabled
     if ((failOnBreaking === false || hasApprovedBreakingChangeLabel) &&
@@ -162,6 +174,18 @@ export async function run() {
         core.info('FailOnBreaking disabled. Forcing SUCCESS');
         conclusion = CheckConclusion.Success;
     }
+    const title = conclusion === CheckConclusion.Failure
+        ? 'Something is wrong with your schema.' + seeCheckURL // add Check URL to navigate users to Check from action.
+        : 'Everything looks good';
+    core.info(`Conclusion: ${conclusion}`);
+    // Action Check is disabled
+    if (checkId === null) {
+        core.info('Github Action Check is disabled, use outputs to determine errors');
+        if (conclusion === CheckConclusion.Failure) {
+            core.setFailed(conclusion);
+        }
+        return;
+    }
     if (useAnnotations === false || isNewSchemaUrl) {
         core.info(`Anotations are disabled. Skipping annotations...`);
         annotations = [];
@@ -172,10 +196,6 @@ export async function run() {
             : annotation.annotation_level !== AnnotationLevel.Notice);
     }
     const summary = createSummary(changes, 100, false);
-    const title = conclusion === CheckConclusion.Failure
-        ? 'Something is wrong with your schema'
-        : 'Everything looks good';
-    core.info(`Conclusion: ${conclusion}`);
     try {
         return await updateCheckRun(octokit, checkId, {
             conclusion,

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@graphql-inspector/action",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "GraphQL Inspector functionality for GitHub Actions",
   "sideEffects": false,
   "dependencies": {
     "@actions/core": "^1.10.1",
     "@actions/github": "^6.0.0",
+    "@graphql-inspector/commands": "^7.0.0",
+    "@graphql-inspector/core": "^8.0.0",
     "dataloader": "^2.2.2",
     "js-yaml": "^4.1.1",
     "probot": "^13.2.2",
-    "tslib": "~2.6.2",
-    "@graphql-inspector/commands": "^7.0.0",
-    "@graphql-inspector/core": "^8.0.0"
+    "tslib": "~2.6.2"
   },
   "repository": {
     "type": "git",

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

@@ -5,6 +5,11 @@ export interface ActionResult {
     annotations?: Annotation[];
     changes?: Change[];
 }
+export interface GroupedChanges {
+    breaking: Change[];
+    dangerous: Change[];
+    safe: Change[];
+}
 export interface Annotation {
     path: string;
     start_line: number;

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

@@ -5,6 +5,11 @@ export interface ActionResult {
     annotations?: Annotation[];
     changes?: Change[];
 }
+export interface GroupedChanges {
+    breaking: Change[];
+    dangerous: Change[];
+    safe: Change[];
+}
 export interface Annotation {
     path: string;
     start_line: number;

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

@@ -1,10 +1,12 @@
 import { Change, CriticalityLevel } from '@graphql-inspector/core';
 import { Endpoint } from './config.cjs';
+import { GroupedChanges } from './types.cjs';
 export declare function bolderize(msg: string): string;
 export declare function quotesTransformer(msg: string, symbols?: string): string;
 export declare function slackCoderize(msg: string): string;
 export declare function discordCoderize(msg: string): string;
 export declare function filterChangesByLevel(level: CriticalityLevel): (change: Change) => boolean;
+export declare function splitChangesIntoGroups(changes: Change[]): GroupedChanges;
 export declare function createSummary(changes: Change[], summaryLimit: number, isLegacyConfig?: boolean): string;
 export declare function isNil(val: any): val is undefined | null;
 export declare function parseEndpoint(endpoint: Endpoint): {

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

@@ -1,10 +1,12 @@
 import { Change, CriticalityLevel } from '@graphql-inspector/core';
 import { Endpoint } from './config.js';
+import { GroupedChanges } from './types.js';
 export declare function bolderize(msg: string): string;
 export declare function quotesTransformer(msg: string, symbols?: string): string;
 export declare function slackCoderize(msg: string): string;
 export declare function discordCoderize(msg: string): string;
 export declare function filterChangesByLevel(level: CriticalityLevel): (change: Change) => boolean;
+export declare function splitChangesIntoGroups(changes: Change[]): GroupedChanges;
 export declare function createSummary(changes: Change[], summaryLimit: number, isLegacyConfig?: boolean): string;
 export declare function isNil(val: any): val is undefined | null;
 export declare function parseEndpoint(endpoint: Endpoint): {