Merge pull request #1612 from JordanGoasdoue/feat-skip-running-status

feat: skip running status (running/pending) if last state
jenkins-x · Jul 2, 2024 · c699cbe · c699cbe
2 parents 1d8c55f + 2d69553
commit c699cbe
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/docs/config/plugins/github-com-jenkins-x-lighthouse-pkg-plugins.md b/docs/config/plugins/github-com-jenkins-x-lighthouse-pkg-plugins.md
@@ -213,6 +213,7 @@ Trigger specifies a configuration for a single trigger.<br /><br />The configura
 | `elide_skipped_contexts` | bool | No | ElideSkippedContexts makes trigger not post "Skipped" contexts for jobs<br />that could run but do not run. |
 | `skip_draft_pr` | bool | No | SkipDraftPR when enabled, skips triggering pipelines for draft PRs<br />unless /ok-to-test is added. |
 | `skip_report_comment` | bool | No | SkipReportComment when enabled, skips report comments in the SCM provider based on the state of<br />the LighthouseJobs. |
+| `skip_report_running_status` | bool | No | SkipReportRunningStatus when enabled, skips report status in the SCM provider based on the current and last state of the LighthouseJobs. |
 
 ## Welcome
 

diff --git a/docs/plugins/Plugins config.md b/docs/plugins/Plugins config.md
@@ -218,6 +218,7 @@ Trigger specifies a configuration for a single trigger.<br /><br />The configura
 | ElideSkippedContexts | `elide_skipped_contexts` | bool | No | ElideSkippedContexts makes trigger not post "Skipped" contexts for jobs<br />that could run but do not run. |
 | SkipDraftPR | `skip_draft_pr` | bool | No | SkipDraftPR when enabled, skips triggering pipelines for draft PRs<br />unless /ok-to-test is added. |
 | SkipReportComment | `skip_report_comment` | bool | No | SkipReportComment when enabled, skips report comments in the SCM provider based on the state of<br />the LighthouseJobs. |
+| SkipReportRunningStatus | `skip_report_running_status` | bool | No | SkipReportRunningStatus when enabled, skips report status in the SCM provider based on the current and last state of<br />the LighthouseJobs. |
 
 ## Welcome
 

diff --git a/pkg/foghorn/controller.go b/pkg/foghorn/controller.go
@@ -184,7 +184,8 @@ func (r *LighthouseJobReconciler) reportStatus(activity *lighthousev1alpha1.Acti
 	repo := activity.Repo
 	gitURL := activity.GitURL
 	activityStatus := activity.Status
-	statusInfo := toScmStatusDescriptionRunningStages(activity, util.GitKind(r.jobConfig.Config))
+	skipReportRunningStatus := r.pluginConfig.Config().TriggerFor(owner, repo).SkipReportRunningStatus
+	statusInfo := toScmStatusDescriptionRunningStages(activity, util.GitKind(r.jobConfig.Config), skipReportRunningStatus)
 
 	fields := map[string]interface{}{
 		"name":        activity.Name,
@@ -224,6 +225,11 @@ func (r *LighthouseJobReconciler) reportStatus(activity *lighthousev1alpha1.Acti
 	// already completed - avoid reporting again if a promotion happens after a PR has merged and the pipeline updates status
 	case scm.StateFailure, scm.StateError, scm.StateSuccess, scm.StateCanceled:
 		return
+	// already in running/pending state - avoid reporting again if we are still in these status
+	case scm.StatePending, scm.StateRunning:
+		if skipReportRunningStatus && (statusInfo.scmStatus == scm.StatePending || statusInfo.scmStatus == scm.StateRunning) {
+			return
+		}
 	}
 
 	r.logger.WithFields(fields).Warnf("last report: %s, current: %s, last desc: %s, current: %s", j.Status.LastReportState, statusInfo.scmStatus.String(),
@@ -283,7 +289,7 @@ type reportStatusInfo struct {
 	runningStages string
 }
 
-func toScmStatusDescriptionRunningStages(activity *lighthousev1alpha1.ActivityRecord, gitKind string) reportStatusInfo {
+func toScmStatusDescriptionRunningStages(activity *lighthousev1alpha1.ActivityRecord, gitKind string, skipReportRunningStatus bool) reportStatusInfo {
 	info := reportStatusInfo{
 		description:   "",
 		runningStages: "",
@@ -307,6 +313,10 @@ func toScmStatusDescriptionRunningStages(activity *lighthousev1alpha1.ActivityRe
 		info.description = "Pipeline in unknown state"
 	}
 
+	if skipReportRunningStatus {
+		return info
+	}
+
 	runningStages := activity.RunningStages()
 	// GitLab does not currently support updating description without changing state, so we need simple descriptions there.
 	// TODO: link to GitLab issue (apb)

diff --git a/pkg/plugins/config.go b/pkg/plugins/config.go
@@ -292,6 +292,9 @@ type Trigger struct {
 	// SkipReportComment when enabled, skips report comments in the SCM provider based on the state of
 	// the LighthouseJobs.
 	SkipReportComment bool `json:"skip_report_comment,omitempty"`
+	// SkipReportRunningStatus when enabled, skips report status in the SCM provider
+	// based on the current and last state of the LighthouseJobs.
+	SkipReportRunningStatus bool `json:"skip_report_running_status,omitempty"`
 }
 
 // Milestone contains the configuration options for the milestone and