renovatebot/renovate

Configurable (always/never) renovate/artifacts status check

Open

#24138 opened on Aug 29, 2023

View on GitHub
 (0 comments) (11 reactions) (0 assignees)TypeScript (14,066 stars) (1,916 forks)batch import
help wantedpriority-3-medium

Description

Describe the proposed change(s).

Allow users to opt into a setting which would result in the renovate/artifacts status check being always set, or never set.

We'd need a new option like artifactsCheckWhen which defaults to "failed" (today's behavior) and with a new option "always" which sets it for every Renovate commit, even if no artifacts are even included in the update, and another one "never", which skips it altogether.

Describe why we need/want these change(s).

This enables users to set this status check as a required check for all Renovate branches, or for those who wish to skip it.

Contributor guide

Tech stack
typescriptnodejs
Domain
devopsci cddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptRenovate configGitHub status checks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Look at the existing configuration definitions in `lib/config/options/index.ts` for similar boolean options like `updateArtifacts`. Then find where the status check 'renovate/artifacts' is created or updated, likely in `lib/workers/repository/process/update artifacts.ts`. Add a new option `artifactsCheckWhen` with values 'failed', 'always', 'never' to the config schema, and modify the logic to conditionally set the status check based on that option.