chore: change depends status from pending to failure

action.yaml

@@ -27,6 +27,13 @@ inputs:
     description: A comma-separated list of keywords
     default: depends on, blocked by
 
+  status_check_type:
+    required: false
+    description: >
+      The status check shown on a dependent PR whose merge is blocked,
+      either "pending" or "failure".
+    default: pending
+
   comment:
     required: false
     description: A custom comment body. It supports `{{ dependencies }}` token.

src/__tests__/helpers.test.ts

@@ -5,6 +5,7 @@ import {
 	DependencyResolver,
 	IssueManager,
 	formatDependency,
+	sanitizeStatusCheckInput,
 } from '../helpers';
 
 test('formatDependency', () => {
@@ -15,6 +16,18 @@ test('formatDependency', () => {
 	expect(formatDependency(dep, repo)).toEqual('#141');
 });
 
+describe('sanitizeStatusCheckInput', () => {
+	it('should default to "pending" on invalid input', () => {
+		expect(sanitizeStatusCheckInput('')).toEqual('pending');
+		expect(sanitizeStatusCheckInput('error')).toEqual('pending');
+	});
+
+	it('should return proper status check on valid input', () => {
+		expect(sanitizeStatusCheckInput('pending')).toEqual('pending');
+		expect(sanitizeStatusCheckInput('failure')).toEqual('failure');
+	});
+});
+
 test('DependencyExtractor', () => {
 	const repo = {
 		owner: 'github',
@@ -209,6 +222,7 @@ describe('IssueManager', () => {
 		actionName: 'my-action',
 		label: 'my-label',
 		commentSignature: '<action-signature>',
+		status_check_type: 'pending',
 	} as ActionContext['config'];
 
 	let listComments: jest.Mock<any, any>;
@@ -251,10 +265,9 @@ describe('IssueManager', () => {
 		};
 
 		beforeEach(() => {
-			((gh.rest.pulls.get as unknown) as jest.Mock<
-				any,
-				any
-			>).mockResolvedValue({ data: pr });
+			(
+				gh.rest.pulls.get as unknown as jest.Mock<any, any>
+			).mockResolvedValue({ data: pr });
 		});
 
 		it('ignores non-PRs', async () => {
@@ -283,7 +296,14 @@ describe('IssueManager', () => {
 			});
 		});
 
-		it('sets the correct status on pending', async () => {
+		it('sets the correct status if blocked and status_check_type input is "pending"', async () => {
+			let configWithStatus = {
+				...config,
+				status_check_type: 'pending',
+			} as ActionContext['config'];
+
+			manager = new IssueManager(gh, repo, configWithStatus);
+
 			const issue = { number: 141, pull_request: {} } as any;
 
 			await manager.updateCommitStatus(issue, [
@@ -302,7 +322,37 @@ describe('IssueManager', () => {
 				description: 'Blocked by owner/repo#999 and 2 more issues',
 				state: 'pending',
 				sha: pr.head.sha,
-				context: config.actionName,
+				context: configWithStatus.actionName,
+			});
+		});
+
+		it('sets the correct status if blocked and status_check_type input is "failure"', async () => {
+			let configWithStatus = {
+				...config,
+				status_check_type: 'failure',
+			} as ActionContext['config'];
+
+			manager = new IssueManager(gh, repo, configWithStatus);
+
+			const issue = { number: 141, pull_request: {} } as any;
+
+			await manager.updateCommitStatus(issue, [
+				{ repo: 'repo', owner: 'owner', number: 999, blocker: true },
+				{ blocker: true } as any,
+				{ blocker: true } as any,
+			]);
+
+			expect(gh.rest.pulls.get).toHaveBeenCalledWith({
+				...repo,
+				pull_number: issue.number,
+			});
+
+			expect(gh.rest.repos.createCommitStatus).toHaveBeenCalledWith({
+				...repo,
+				description: 'Blocked by owner/repo#999 and 2 more issues',
+				state: 'failure',
+				sha: pr.head.sha,
+				context: configWithStatus.actionName,
 			});
 		});
 	});

src/context.ts

@@ -1,6 +1,7 @@
 // Packages
 import * as core from '@actions/core';
 import * as github from '@actions/github';
+import { sanitizeStatusCheckInput } from './helpers';
 
 // Ours
 import { ActionContext, GithubClient, Issue } from './types';
@@ -21,6 +22,9 @@ export async function getActionContext(): Promise<ActionContext> {
 			.trim()
 			.split(',')
 			.map((kw) => kw.trim()),
+		status_check_type: sanitizeStatusCheckInput(
+			core.getInput('status_check_type')
+		),
 	};
 
 	if (config.keywords.length === 0) {

src/helpers.ts

@@ -11,6 +11,8 @@ import {
 	GithubClient,
 	ActionContext,
 	Comment,
+	StatusCheck,
+	isValidStatusCheck,
 } from './types';
 
 export function formatDependency(dep: Dependency, repo?: Repository) {
@@ -23,6 +25,14 @@ export function formatDependency(dep: Dependency, repo?: Repository) {
 	return `${dep.owner}/${dep.repo}#${dep.number}`;
 }
 
+export function sanitizeStatusCheckInput(statusCheckInput: string) {
+	const statusCheck = isValidStatusCheck(statusCheckInput)
+		? statusCheckInput
+		: 'pending';
+
+	return statusCheck as StatusCheck;
+}
+
 export class DependencyExtractor {
 	private regex: RegExp;
 	private issueRegex = IssueRegex();
@@ -343,7 +353,7 @@ export class IssueManager {
 			description,
 			sha: pull.head.sha,
 			context: this.config.actionName,
-			state: isBlocked ? 'pending' : 'success',
+			state: isBlocked ? this.config.status_check_type : 'success',
 		});
 	}
 }

src/types.ts

@@ -19,6 +19,11 @@ export type Dependency = Required<typeof github.context.issue> & {
 };
 export type Repository = Required<typeof github.context.repo>;
 
+export const statusChecks = ['pending', 'failure'];
+export type StatusCheck = 'pending' | 'failure';
+export const isValidStatusCheck = (statusCheckInput: string) =>
+	statusChecks.includes(statusCheckInput);
+
 export type ActionContext = {
 	client: GithubClient;
 	readOnlyClient: GithubClient;
@@ -32,5 +37,6 @@ export type ActionContext = {
 		check_issues: string;
 		ignore_dependabot: string;
 		keywords: string[];
+		status_check_type: StatusCheck;
 	};
 };