feat(logging): group logging in github by task id

cli/internal/run/real_run.go

@@ -325,6 +325,10 @@ func (ec *execContext) exec(ctx gocontext.Context, packageTask *nodes.PackageTas
  WarnPrefix: prettyPrefix,
  }
 
+ if ec.rs.Opts.runOpts.IsGithubActions {
+ ui.Output(fmt.Sprintf("::group::%s", packageTask.OutputPrefix(ec.isSinglePackage)))
+ }
+
  cacheStatus, err := taskCache.RestoreOutputs(ctx, prefixedUI, progressLogger)
 
  // It's safe to set the CacheStatus even if there's an error, because if there's
@@ -413,6 +417,11 @@ func (ec *execContext) exec(ctx gocontext.Context, packageTask *nodes.PackageTas
 
  closeOutputs := func() error {
  var closeErrors []error
+ if ec.rs.Opts.runOpts.IsGithubActions {
+ // We don't use the prefixedUI here because the prefix in this case would include
+ // the ::group::<taskID>, and we explicitly want to close the github group
+ ui.Output("::endgroup::")
+ }
 
  if err := logStreamerOut.Close(); err != nil {
  closeErrors = append(closeErrors, errors.Wrap(err, "log stdout"))

cli/internal/run/run.go

@@ -9,6 +9,7 @@ import (
 
  "github.com/vercel/turbo/cli/internal/analytics"
  "github.com/vercel/turbo/cli/internal/cache"
+ "github.com/vercel/turbo/cli/internal/ci"
  "github.com/vercel/turbo/cli/internal/cmdutil"
  "github.com/vercel/turbo/cli/internal/context"
  "github.com/vercel/turbo/cli/internal/core"
@@ -128,6 +129,13 @@ func optsFromArgs(args *turbostate.ParsedArgsFromRust) (*Opts, error) {
 }
 
 func configureRun(base *cmdutil.CmdBase, opts *Opts, signalWatcher *signals.Watcher) *run {
+ if opts.runOpts.LogOrder == "auto" {
+ if name := ci.Constant(); name == "GITHUB_ACTIONS" {
+ opts.runOpts.LogOrder = "grouped"
+ opts.runOpts.IsGithubActions = true
+ }
+ }
+
  processes := process.NewManager(base.Logger.Named("processes"))
  signalWatcher.AddOnClose(processes.Close)
  return &run{

cli/internal/util/run_opts.go

@@ -55,4 +55,7 @@ type RunOpts struct {
  Summarize bool
 
  ExperimentalSpaceID string
+
+ // Whether this run is in Github Actions
+ IsGithubActions bool
 }

examples-tests/setup.sh

@@ -72,3 +72,16 @@ fi
 [ ! -d .git ] || rm -rf .git
 
 "$MONOREPO_ROOT_DIR/turborepo-tests/helpers/setup_git.sh" "${TARGET_DIR}" "false"
+
+# We set this explicitly to stream, so we can lock into to streaming logs (i.e. not "auto") behavior.
+#
+# We do this because when these tests are invoked in CI (through .github/actions/test.yml), they will
+# inherit the GITHUB_ACTIONS=true env var, and each of the `turbo run` invocations into behavior
+# we do not want. Since prysk mainly tests log output, this extra behavior will break all the tests
+# and can be unpredictable over time, as we make "auto" do more magic.
+#
+# Note: since these tests are invoked _through_ turbo, the ideal setup would be to pass --env-mode=strict
+# so we can prevent the `GITHUB_ACTIONS` env var from being passed down here from the top level turbo.
+# But as of now, this breaks our tests (and I'm not sure why). If we make that work, we can remove this
+# explicit locking of log order. See PR attempt here: https://github.com/vercel/turbo/pull/5324
+export TURBO_LOG_ORDER=stream

turborepo-tests/e2e/index.ts

@@ -8,6 +8,19 @@ import { Monorepo } from "./monorepo";
 import path from "path";
 import * as fs from "fs";
 
+// We set this explicitly to stream, so we can lock into to streaming logs (i.e. not "auto") behavior.
+//
+// We do this because when these tests are invoked in CI (through .github/actions/test.yml), they will
+// inherit the GITHUB_ACTIONS=true env var, and each of the `turbo run` invocations into behavior
+// we do not want. Since prysk mainly tests log output, this extra behavior will break all the tests
+// and can be unpredictable over time, as we make "auto" do more magic.
+//
+// Note: since these tests are invoked _through_ turbo, the ideal setup would be to pass --env-mode=strict
+// so we can prevent the `GITHUB_ACTIONS` env var from being passed down here from the top level turbo.
+// But as of now, this breaks our tests (and I'm not sure why). If we make that work, we can remove this
+// explicit locking of log order. See PR attempt here: https://github.com/vercel/turbo/pull/5324
+process.env.TURBO_LOG_ORDER = "stream";
+
 const basicPipeline = {
  pipeline: {
  test: {

turborepo-tests/integration/test.sh

@@ -1,5 +1,18 @@
 #!/bin/bash
 
+# We set this explicitly to stream, so we can lock into to streaming logs (i.e. not "auto") behavior.
+#
+# We do this because when these tests are invoked in CI (through .github/actions/test.yml), they will
+# inherit the GITHUB_ACTIONS=true env var, and each of the `turbo run` invocations into behavior
+# we do not want. Since prysk mainly tests log output, this extra behavior will break all the tests
+# and can be unpredictable over time, as we make "auto" do more magic.
+#
+# Note: since these tests are invoked _through_ turbo, the ideal setup would be to pass --env-mode=strict
+# so we can prevent the `GITHUB_ACTIONS` env var from being passed down here from the top level turbo.
+# But as of now, this breaks our tests (and I'm not sure why). If we make that work, we can remove this
+# explicit locking of log order. See PR attempt here: https://github.com/vercel/turbo/pull/5324
+export TURBO_LOG_ORDER=stream
+
 if [ "$1" = "" ]; then
  .cram_env/bin/prysk --shell="$(which bash)" tests
 else