Update README.md

[guitarrapc]

Description

Improvement.

This PR explicitly guide user to use action/checkout with clean: false option.

Background

Please correct me if my understand is wrong. DeNA/setup-job-workspace-action is to achieve Jenkins checkout strategy "keeps .git for each node & job" on GitHub Actions by "keep .git for each runner & workspace". Therefore actions/checkout still expected to be used with clean: false option to avoid git clean -ffdx.

Current README.md not indicate actions/checkout to use with clean: false, however it may reduce confusion to explicitly show example.

Related issue:

Contributor License Agreements

• By placing an "x" in the box, I hereby understand, accept and agree to be bound by the terms and conditions of the Contribution License Agreement.

[Kesin11]

@guitarrapc I agree with your diff.
However, I think that if you set clean: false, you will need to run git clean -ffd yourself. Without running git clean, files that generated by the previous run may affect the current run.
Therefore, we should also add run: git clean -ffd in example.

@srz-zumix @VeyronSakai What do you think? How do you do this in your actual Unity workflow?

[Kesin11]

@srz-zumix @VeyronSakai check-dist job blocked to merge. Since check-dist job will not trigger if the pull-request has only *.md diff, check-dist job should be removed from branch protection rules.

[Kesin11]

What do you think? How do you do this in your actual Unity workflow?

@srz-zumix @VeyronSakai Since I don't use Unity anymore, can you guys tell me about your actual workflow?

[srz-zumix]

We are using as a below

- name: Switch workspace
  uses: DeNA/setup-job-workspace-action@v2
  with:
    # Change path by build option
    suffix: "${{ (inputs.enable_XXX && '-XXX') || '' }}"
- uses: actions/checkout@v3
  with:
    # For clean everything
    clean: ${{ inputs.clean || false }}
- name: Git clean without Library
  run: git clean -xffd --exclude Library

[srz-zumix]

I thought it would be fine without clean:false in Usage.
Because this is an input for the checkout action and not for the setup-job-workspace-action.

How about adding a section like Example and adding the above Unity example there?

[guitarrapc]

@srz-zumix I've reverted usage, and added Example section as you mentioned. May I ask you review change?

[Kesin11]

How about adding a section like Example and adding the above Unity example there?

I also agree it. LGTM 👍

[srz-zumix]

LGTM!