Support fetching without the --progress option

[simonbaird]

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]

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

[simonbaird]

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

[simonbaird]

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

[yeikel]

What is blocking this change?

I am looking forward to seeing this released as well

[simonbaird]

Rebased on upstream/main, (currently f095bcc).

[simonbaird]

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]

I reworded the PR description and added some additional explanations.

[simonbaird]

@ericsciple WDYT?

[simonbaird]

Rebased on 96f5310.

[simonbaird]

$ 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]

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

[slang25]

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

[yeikel]

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]

I'll give it another rebase.

[simonbaird]

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

[simonbaird]

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]

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 .

[yeikel]

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]

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!