Merge pull request #720 from danicheg/tweak-dependency-submission

Do not run the 'dependency-submission' job in CI for forked repositories

Author: armanbilge

.github/workflows/ci.yml

@@ -393,7 +393,7 @@ jobs:
 
   dependency-submission:
     name: Submit Dependencies
-    if: github.event_name != 'pull_request'
+    if: github.event.repository.fork == false && github.event_name != 'pull_request'
     strategy:
       matrix:
         os: [ubuntu-latest]

ci/src/main/scala/org/typelevel/sbt/TypelevelCiPlugin.scala

@@ -52,6 +52,10 @@ object TypelevelCiPlugin extends AutoPlugin {
     lazy val tlCiStewardValidateConfig = settingKey[Option[File]](
       "The location of the Scala Steward config to validate (default: `.scala-steward.conf`, if exists)")
 
+    lazy val tlCiForkCondition =
+      settingKey[String](
+        "Condition for checking on CI whether this project is a fork of another (default: `github.event.repository.fork == false`)")
+
   }
 
   import autoImport._
@@ -64,6 +68,7 @@ object TypelevelCiPlugin extends AutoPlugin {
     tlCiMimaBinaryIssueCheck := false,
     tlCiDocCheck := false,
     tlCiDependencyGraphJob := true,
+    tlCiForkCondition := "github.event.repository.fork == false",
     githubWorkflowTargetBranches ++= Seq(
       "!update/**", // ignore steward branches
       "!pr/**" // escape-hatch to disable ci on a branch
@@ -139,6 +144,9 @@ object TypelevelCiPlugin extends AutoPlugin {
     },
     githubWorkflowJavaVersions := Seq(JavaSpec.temurin("8")),
     githubWorkflowAddedJobs ++= {
+      val ghEventCond = "github.event_name != 'pull_request'"
+      val jobCond = s"${tlCiForkCondition.value} && $ghEventCond"
+
       val dependencySubmission =
         if (tlCiDependencyGraphJob.value)
           List(
@@ -155,7 +163,7 @@ object TypelevelCiPlugin extends AutoPlugin {
                   Some(List("test", "scala-tool", "scala-doc-tool", "test-internal")),
                   None
                 ),
-              cond = Some("github.event_name != 'pull_request'")
+              cond = Some(jobCond)
             ))
         else Nil
 

docs/customization.md

@@ -66,7 +66,8 @@ Both plugins are documented in [**sbt-typelevel-github-actions**](gha.md).
 - `tlCiScalafixCheck` (setting): Whether to do scalafix check in CI (default: `false`).
 - `tlCiMimaBinaryIssueCheck` (setting): Whether to do MiMa binary issues check in CI (default: `false`).
 - `tlCiDocCheck` (setting): Whether to build API docs in CI (default: `false`).
-- `tlCiDependencyGraphJob` (setting): Whether to add a job to submit dependencies to GH (default: `true`)
+- `tlCiDependencyGraphJob` (setting): Whether to add a job to submit dependencies to GH (default: `true`).
+- `tlCiForkCondition` (setting): Condition for checking on CI whether this project is a fork of another (default: `github.event.repository.fork == false`).
 - `tlCiStewardValidateConfig` (setting): The location of the Scala Steward config to validate (default: `.scala-steward.conf`, if exists).
 - `tlCrossRootProject` (method): helper to create a `root` project that can aggregate both `Project`s and `CrossProject`s. Automatically creates separate jobs in the CI matrix for each platform (JVM, JS, etc.).