Support fetching without the --progress option #1067

simonbaird · 2023-01-05T05:14:00Z

If this is merged, setting the progress option to false in the with section of the workflow step will cause git fetch to run without the --progress flag.

Note that the default value of this new option is true, which matches the current behavior, so this PR introduces no behavior change unless the new option is explicitly present and set to false.

The motivation is to be able to suppress the noisy progress status output which adds many hundreds of remote: Counting objects: 85% (386/453) and similar lines in the workflow log.

This should be sufficient to resolve #894 and its older friends, though the solution is different to the one proposed there because it doesn't use the --quiet flag. IIUC git doesn't show the progress status by default when running on GitHub since the output is not a terminal. Adding the --progress flag is what forces the progress output to be shown, so that's why removing it is all that's needed.

Adding the --quiet flag doesn't make a lot of difference once the --progress flag is removed, and actually I think using --quiet would suppress some other more useful output that would be better left visible.

simonbaird · 2023-01-05T05:21:32Z

I'm using it here and it seems to work well.

simonbaird · 2023-01-05T05:27:30Z

This workflow run shows it working with the --progress option set which is still the default behavior.

simonbaird · 2023-02-01T23:13:39Z

@TingluoHuang would this be something you'd consider taking a look at? I'm looking at your comments from 2019 on #18.

yeikel · 2023-05-03T14:43:57Z

What is blocking this change?

I am looking forward to seeing this released as well

simonbaird · 2023-05-04T19:30:08Z

Rebased on upstream/main, (currently f095bcc).

simonbaird · 2023-05-04T19:33:49Z

Passes formatting and lint checks for me locally:

$ for t in build format-check lint; do npm run $t; done

> checkout@3.5.2 build
> tsc && ncc build && node lib/misc/generate-docs.js

ncc: Version 0.36.1
ncc: Compiling file index.js into CJS
877kB  dist/index.js
877kB  [1343ms] - ncc 0.36.1

> checkout@3.5.2 format-check
> prettier --check '**/*.ts'

Checking formatting...
All matched files use Prettier code style!

> checkout@3.5.2 lint
> eslint src/**/*.ts

And tests:

$ npm test
...
Test Suites: 7 passed, 7 total
Tests:       68 passed, 68 total
Snapshots:   0 total
Time:        7.829 s, estimated 8 s
Ran all test suites.

simonbaird · 2023-05-05T14:24:27Z

I reworded the PR description and added some additional explanations.

simonbaird · 2023-05-05T14:45:33Z

@ericsciple WDYT?

simonbaird · 2023-07-25T20:42:29Z

Rebased on 96f5310.

simonbaird · 2023-07-25T20:50:00Z

$ for t in build format-check lint; do npm run $t; done

> checkout@3.5.3 build
> tsc && ncc build && node lib/misc/generate-docs.js

ncc: Version 0.36.1
ncc: Compiling file index.js into CJS
879kB  dist/index.js
879kB  [1112ms] - ncc 0.36.1

> checkout@3.5.3 format-check
> prettier --check '**/*.ts'

Checking formatting...
All matched files use Prettier code style!

> checkout@3.5.3 lint
> eslint src/**/*.ts

bf · 2023-08-02T14:49:14Z

Guys, what is blocking this? Would be really nice to have. Currently the checkout pollutes my logs.

slang25 · 2023-08-30T11:15:16Z

@luketomlinson are you able to comment, there are a lot of people wanting this.

yeikel · 2023-08-30T18:12:43Z

Well, currently there are conflicts. It would help if we can resolve these first. Otherwise it'll take more time before this is looked at again

@simonbaird Could you please work on that?

simonbaird · 2023-08-30T20:18:44Z

I'll give it another rebase.

Setting the `progress` option to false in the `with` section of the workflow step will cause git fetch to run without `--progress`. The motivation is to be able to suppress the noisy progress status output which adds many hundreds of "remote: Counting objects: 85% (386/453)" and similar lines in the workflow log. This should be sufficient to resolve actions#894 and its older friends, though the solution is different to the one proposed there because it doesn't use the --quiet flag. IIUC git doesn't show the progress status by default since the output is not a terminal, so that's why removing the --progress option is all that's needed. Adding the --quiet flag doesn't make a lot of difference once the --progress flag is removed, and actually I think using --quiet would suppress some other more useful output that would be better left visible. Signed-off-by: Simon Baird <sbaird@redhat.com>

simonbaird · 2023-08-30T20:35:44Z

Rebased on upstream/main (currently at 97a652b). Now includes some test coverage 😎 .

simonbaird · 2023-08-30T20:42:06Z

__test__/git-command-manager.test.ts

+      showProgress: true
+    }
+
+    await git.fetch(refSpec, options)


It might be nice to merge these options onto the default option values here so the assertions become more like real world examples. (This is just an idea for a separate PR though.)

simonbaird · 2023-08-30T20:58:10Z

__test__/git-command-manager.test.ts

+      ],
+      expect.any(Object)
+    )
+  })


I'd be happy to remove some of the test coverage if it's considered too much. I was trying to follow the example set in #579 .

Too much coverage is rarely a problem. Thank you for the detailed effort!

vanZeben

Thanks for putting this together @simonbaird, especially with the comprehensive test coverage! 🎉 I'll cut a release for this later today

vanZeben · 2023-09-01T18:33:12Z

I lied, checking internally, we're planning on cutting a new Major version release next week to include the recent node20 bump, that major release will include this too, so look forward to v4.0.0 for this change!

Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/actions/checkout/releases">actions/checkout's releases</a>.</em></p> <blockquote> <h2>v4.0.0</h2> <h2>What's Changed</h2> <ul> <li>Update default runtime to node20 by <a href="https://github.com/takost"><code>@takost</code></a> in <a href="h ttps://redirect.github.com/actions/checkout/pull/1436">actions/checkout# 1436</a></li> <li>Support fetching without the --progress option by <a href="https://github.com/simonbaird"><code>@simonbaird</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1067">actions/ch eckout#1067</a></li> <li>Release 4.0.0 by <a href="https://github.com/takost"><code>@takost</code></a> in <a href="h ttps://redirect.github.com/actions/checkout/pull/1447">actions/checkout# 1447</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/takost"><code>@takost</code></a> made their first contribution in <a href="https://redirect.github.com/actions /checkout/pull/1436">actions/checkout#1436</a></li> <li><a href="https://github.com/simonbaird"><code>@simonbaird</code></a> made their first contribution in <a href="https://redirect.github.com/actions /checkout/pull/1067">actions/checkout#1067</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/ checkout/compare/v3...v4.0.0">https://github.com/actions/checkout/compar e/v3...v4.0.0</a></p> <h2>v3.6.0</h2> <h2>What's Changed</h2> <ul> <li>Mark test scripts with Bash'isms to be run via Bash by <a href="https://github.com/dscho"><code>@dscho</code></a> in <a href="htt ps://redirect.github.com/actions/checkout/pull/1377">actions/checkout#13 77</a></li> <li>Add option to fetch tags even if fetch-depth > 0 by <a href="http s://github.com/RobertWieczoreck"><code>@RobertWieczoreck</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/579">actions/ checkout#579</a></li> <li>Release 3.6.0 by <a href="https://github.com/luketomlinson"><code>@luketomlinson</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1437">acti ons/checkout#1437</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/RobertWieczoreck"><code>@RobertWieczore ck</code></a> made their first contribution in <a href="https://redirect .github.com/actions/checkout/pull/579">actions/checkout#579</a></li> <li><a href="https://github.com/luketomlinson"><code>@luketomlinson</code></a> made their first contribution in <a href="https://redirect.github.com/ac tions/checkout/pull/1437">actions/checkout#1437</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/ checkout/compare/v3.5.3...v3.6.0">https://github.com/actions/checkout/co mpare/v3.5.3...v3.6.0</a></p> <h2>v3.5.3</h2> <h2>What's Changed</h2> <ul> <li>Fix: Checkout Issue in self hosted runner due to faulty submodule check-ins by <a href="https://github.com/megamanics"><code>@megamanics</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1196">actions/ch eckout#1196</a></li> <li>Fix typos found by codespell by <a href="https://github.com/DimitriP apadopoulos"><code>@DimitriPapadopoulos</code></a> in <a href="https:// redirect.github.com/actions/checkout/pull/1287">actions/checkout#1287</a ></li> <li>Add support for sparse checkouts by <a href="https://github.com/dscho"><code>@dscho</code></a> and <a href="https://github.com/dfdez"><code>@dfdez</code></a> in <a href="htt ps://redirect.github.com/actions/checkout/pull/1369">actions/checkout#13 69</a></li> <li>Release v3.5.3 by <a href="https://github.com/TingluoHuang"><code>@TingluoHuang</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1376">acti ons/checkout#1376</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/megamanics"><code>@megamanics</code></a> made their first contribution in <a href="https://redirect.github.com/actions /checkout/pull/1196">actions/checkout#1196</a></li> <li><a href="https://github.com/DimitriPapadopoulos"><code>@DimitriPapa dopoulos</code></a> made their first contribution in <a href="https://re direct.github.com/actions/checkout/pull/1287">actions/checkout#1287</a>< /li> <li><a href="https://github.com/dfdez"><code>@dfdez</code></a> made their first contribution in <a href="https://redirect.github.com/actions /checkout/pull/1369">actions/checkout#1369</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/ checkout/compare/v3...v3.5.3">https://github.com/actions/checkout/compar e/v3...v3.5.3</a></p> <h2>v3.5.2</h2> <h2>What's Changed</h2> <ul> <li>Fix: Use correct API url / endpoint in GHES by <a href="https://github.com/fhammerl"><code>@fhammerl</code></a> in <a hre f="https://redirect.github.com/actions/checkout/pull/1289">actions/check out#1289</a> based on <a href="https://redirect.github.com/actions/check out/issues/1286">sagemath#1286</a> by <a href="https://github.com/1newsr"><code>@1newsr</code></a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/ checkout/compare/v3.5.1...v3.5.2">https://github.com/actions/checkout/co mpare/v3.5.1...v3.5.2</a></p> <h2>v3.5.1</h2> <h2>What's Changed</h2> <ul> <li>Improve checkout performance on Windows runners by upgrading <code>@actions/github</code> dependency by <a href="https://github.com/BrettDong"><code>@BrettDong</code></a> in <a h ref="https://redirect.github.com/actions/checkout/pull/1246">actions/che ckout#1246</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/BrettDong"><code>@BrettDong</code></a> made their first contribution in <a href="https://redirect.github.com/ac tions/checkout/pull/1246">actions/checkout#1246</a></li> </ul>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/actions/checkout/blob/ma in/CHANGELOG.md">actions/checkout's changelog</a>.</em></p> <blockquote> <h1>Changelog</h1> <h2>v4.0.0</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/1067">Support fetching without the --progress option</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/1436">Update to node20</a></li> </ul> <h2>v3.6.0</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/1377">Fix: Mark test scripts with Bash'isms to be run via Bash</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/579">Add option to fetch tags even if fetch-depth > 0</a></li> </ul> <h2>v3.5.3</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/1196">Fix: Checkout fail in self-hosted runners when faulty submodule are checked- in</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/1287">Fix typos found by codespell</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/1369">Add support for sparse checkouts</a></li> </ul> <h2>v3.5.2</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/1289">Fix api endpoint for GHES</a></li> </ul> <h2>v3.5.1</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/1246">Fix slow checkout on Windows</a></li> </ul> <h2>v3.5.0</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/1237">Add new public key for known_hosts</a></li> </ul> <h2>v3.4.0</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/1209">Upgrade codeql actions to v2</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/1210">Upgrade dependencies</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/1225">Upgrade <code>@actions/io</code></a></li> </ul> <h2>v3.3.0</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/1045">Implement branch list using callbacks from exec function</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/1050">Add in explicit reference to private checkout options</a></li> <li>[Fix comment typos (that got added in <a href="https://redirect.gith ub.com/actions/checkout/issues/770">sagemath#770</a>)](<a href="https://redirect .github.com/actions/checkout/pull/1057">actions/checkout#1057</a>)</li> </ul> <h2>v3.2.0</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/942">Add GitHub Action to perform release</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/967">Fix status badge</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/1002">Replace datadog/squid with ubuntu/squid Docker image</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/964">Wrap pipeline commands for submoduleForeach in quotes</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/1029">Update <code>@actions/io</code> to 1.1.2</a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/1039">Upgrading version to 3.2.0</a></li> </ul> <h2>v3.1.0</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/939">Use <code>@actions/core</code> <code>saveState</code> and <code>getState</code></a></li> <li><a href="https://redirect.github.com/actions/checkout/pull/922">Add <code>github-server-url</code> input</a></li> </ul> <h2>v3.0.2</h2> <ul> <li><a href="https://redirect.github.com/actions/checkout/pull/770">Add input <code>set-safe-directory</code></a></li> </ul> <h2>v3.0.1</h2>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="actions/checkout@3df4ab11eba7bda6 032a0b82a6bb43b11571feac"><code>3df4ab1</code></a> Release 4.0.0 (<a hre f="https://redirect.github.com/actions/checkout/issues/1447">#1447</a>)< /li> <li><a href="actions/checkout@8b5e8b768746b503 94015010d25e690bfab9dfbc"><code>8b5e8b7</code></a> Support fetching without the --progress option (<a href="https://redirect.github.com/acti ons/checkout/issues/1067">sagemath#1067</a>)</li> <li><a href="actions/checkout@97a652b80035363d f47baee5031ec8670b8878ac"><code>97a652b</code></a> Update default runtime to node20 (<a href="https://redirect.github.com/actions/checkout sagemath/issues/1436">sagemath#1436</a>)</li> <li>See full diff in <a href="https://github.com/actions/checkout/compare/v3...v4">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot- badges.githubapp.com/badges/compatibility_score?dependency- name=actions/checkout&package-manager=github_actions&previous- version=3&new-version=4)](https://docs.github.com/en/github/managing- security-vulnerabilities/about-dependabot-security-updates#about- compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> URL: sagemath#36243 Reported by: dependabot[bot] Reviewer(s):

actions/checkout#1067

actions/checkout#1067

Also disable --progress. It is not disabled by default for backward compatibility, but solves the problem of lots of progress lines in the downloadable raw output: actions/checkout#1067

@commitlint

simonbaird requested a review from a team as a code owner January 5, 2023 05:14

simonbaird mentioned this pull request Jan 5, 2023

Run git fetch with --quiet by default #894

Closed

simonbaird mentioned this pull request Jan 5, 2023

use quiet #18

Closed

simonbaird force-pushed the no-progress-option branch from 51e92ef to 87596e0 Compare January 5, 2023 22:00

simonbaird mentioned this pull request Jan 6, 2023

Run git fetch with --quiet by default #489

Closed

simonbaird force-pushed the no-progress-option branch from 87596e0 to 3327cce Compare May 4, 2023 19:29

simonbaird force-pushed the no-progress-option branch from 3327cce to ce4272e Compare July 25, 2023 20:38

simonbaird force-pushed the no-progress-option branch from ce4272e to d053b2f Compare July 25, 2023 20:44

simonbaird force-pushed the no-progress-option branch from d053b2f to 4d7e069 Compare August 30, 2023 20:33

simonbaird commented Aug 30, 2023

View reviewed changes

vanZeben approved these changes Sep 1, 2023

View reviewed changes

vanZeben merged commit 8b5e8b7 into actions:main Sep 1, 2023
11 checks passed

LoicGrobol mentioned this pull request Sep 11, 2023

Bump actions/checkout from 3 to 4 LoicGrobol/document-numerique#9

Merged

kailas234 mentioned this pull request Sep 22, 2023

Bump actions/checkout from 3 to 4 kailas234/skills-introduction-to-github#1

Open

HAZEM45411111 mentioned this pull request Oct 2, 2023

Bump actions/checkout from 3 to 4 HAZEM45411111/skills-communicate-using-markdown#1

Open

gitfool added a commit to gitfool/cake-docker that referenced this pull request Oct 21, 2023

Disable checkout show progress

3af3f11

actions/checkout#1067

gitfool added a commit to gitfool/Cake.Dungeon that referenced this pull request Oct 21, 2023

Disable checkout show progress

e7228b1

actions/checkout#1067

gitfool added a commit to gitfool/GitHubActions.Dungeon that referenced this pull request Oct 21, 2023

Disable checkout show progress

32e4fc9

actions/checkout#1067

sad270 mentioned this pull request Nov 4, 2023

chore(github): update GitHub Actions api-platform/core#5946

Closed

zhangsheng851912 mentioned this pull request Nov 17, 2023

Bump actions/checkout from 3 to 4 zhangsheng851912/skills-introduction-to-github#1

Open

lahma mentioned this pull request Nov 29, 2023

Support for actions/checkout@v4 with progress and filter nuke-build/nuke#1298

Open

3 tasks

lc6464 mentioned this pull request Dec 6, 2023

修改一些 .github 配置 yuantuo666/baiduwp-php#348

Merged

gitfool added a commit to gitfool/Cake.Dungeon that referenced this pull request Jan 7, 2024

Disable checkout show progress

d04947a

actions/checkout#1067

gitfool added a commit to gitfool/BoardGameGeek.Dungeon that referenced this pull request Jan 7, 2024

Disable checkout show progress

21aec04

actions/checkout#1067

gitfool added a commit to gitfool/Pulumi.Dungeon that referenced this pull request Jan 13, 2024

Disable checkout show progress

9a755f6

actions/checkout#1067

gitfool added a commit to gitfool/Pulumi.Dungeon that referenced this pull request Jan 13, 2024

Disable checkout show progress

d7cad76

actions/checkout#1067

m-nakamura145 mentioned this pull request Jan 17, 2024

Update latest checkout action version rails/sdoc#362

Merged

link2xt mentioned this pull request Feb 15, 2024

ci: update to actions/checkout@v4 deltachat/deltachat-core-rust#5267

Merged

Alnusjaponica mentioned this pull request Mar 28, 2024

Update GitHub actions versions of actions/setup-python and actions/checkout optuna/optuna#5367

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support fetching without the --progress option #1067

Support fetching without the --progress option #1067

simonbaird commented Jan 5, 2023 •

edited

simonbaird commented Jan 5, 2023

simonbaird commented Jan 5, 2023 •

edited

simonbaird commented Feb 1, 2023

yeikel commented May 3, 2023

simonbaird commented May 4, 2023

simonbaird commented May 4, 2023 •

edited

simonbaird commented May 5, 2023 •

edited

simonbaird commented May 5, 2023

simonbaird commented Jul 25, 2023

simonbaird commented Jul 25, 2023

bf commented Aug 2, 2023

slang25 commented Aug 30, 2023

yeikel commented Aug 30, 2023

simonbaird commented Aug 30, 2023

simonbaird commented Aug 30, 2023

simonbaird Aug 30, 2023 •

edited

simonbaird Aug 30, 2023

yeikel Aug 31, 2023 •

edited

vanZeben left a comment

vanZeben commented Sep 1, 2023

Support fetching without the --progress option #1067

Support fetching without the --progress option #1067

Conversation

simonbaird commented Jan 5, 2023 • edited

simonbaird commented Jan 5, 2023

simonbaird commented Jan 5, 2023 • edited

simonbaird commented Feb 1, 2023

yeikel commented May 3, 2023

simonbaird commented May 4, 2023

simonbaird commented May 4, 2023 • edited

simonbaird commented May 5, 2023 • edited

simonbaird commented May 5, 2023

simonbaird commented Jul 25, 2023

simonbaird commented Jul 25, 2023

bf commented Aug 2, 2023

slang25 commented Aug 30, 2023

yeikel commented Aug 30, 2023

simonbaird commented Aug 30, 2023

simonbaird commented Aug 30, 2023

simonbaird Aug 30, 2023 • edited

Choose a reason for hiding this comment

simonbaird Aug 30, 2023

Choose a reason for hiding this comment

yeikel Aug 31, 2023 • edited

Choose a reason for hiding this comment

vanZeben left a comment

Choose a reason for hiding this comment

vanZeben commented Sep 1, 2023

simonbaird commented Jan 5, 2023 •

edited

simonbaird commented Jan 5, 2023 •

edited

simonbaird commented May 4, 2023 •

edited

simonbaird commented May 5, 2023 •

edited

simonbaird Aug 30, 2023 •

edited

yeikel Aug 31, 2023 •

edited