infra: add CI step to detect generate script diffs

[sunadoi]

#813

After running the generate:locales command in the workflow/ci pipeline, check for some uncommitted diffs with the following command.

git add .
git diff --cached --exit-code

• The --exit-code option causes it to fail if there are any diffs.

I tested this CI on my repository.
It seems to work well.
ref: https://github.com/sunadoi/faker/actions/runs/3164634036/jobs/5153063988

[codecov]

Codecov Report

Merging #1405 (ada8798) into main (13dac4f) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1405   +/-   ##
=======================================
  Coverage   99.61%   99.61%           
=======================================
  Files        2166     2166           
  Lines      237442   237442           
  Branches     1040     1040           
=======================================
  Hits       236535   236535           
  Misses        886      886           
  Partials       21       21           

[ST-DDT]

This does not detect deleted files, but I'm not sure whether this is necessary.

[sunadoi]

This does not detect deleted files

I didn't give it enough thought.
How about checking git diff before and after git add?
The former checks for file updates/deletions, the latter checks for file creation.

git diff --exit-code
git add -N .
git diff --exit-code

[sunadoi]

To be able to detect deleted files, the method of checking for diffs has been changed to the following command.

git add .
git diff --cached --exit-code

[ST-DDT]

I tried to run it in my fork and it doesn't work:
https://github.com/ST-DDT/faker/actions/runs/3175539763/jobs/5173706263#step:8:17

You might need the PR write permission for that action.
https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs

Please assign it for the lowest possible scope (e.g. only for this single job).

[sunadoi]

Please assign it for the lowest possible scope (e.g. only for this single job).

I gave permissions pull-requests: write in this job only, and it seems to work in my fork.
https://github.com/sunadoi/faker/actions/runs/3179609661/jobs/5182304903

[ST-DDT]

@Shinigami92 Is these Jsdocs what you intended with your request?
Maybe you could give an example of what you would like to have.

[Shinigami92]

Beside that, I think we are good to go 👍
So I will already approve so other maintainers know that it counts after you fixed the dep version

[ST-DDT]

Do we have to .gitginore the transpiled .js script?

• If yes, why is the script not failing?
• If not, why not?

[ST-DDT]

Do we have to .gitginore the transpiled .js script?

* If yes, why is the script not failing?

* If not, why not?

Ah I see, because it is transpiled only after the check.
Please add *.js files in the workflows folder to the gitignore anyway, in case somebody transpiles it locally.

(I plan to use your script as a template to automate some more tasks 😻 )

[sunadoi]

(I plan to use your script as a template to automate some more tasks 😻 )

That sounds nice!
I'm so happy to hear that.😘

[ST-DDT]

@sunadoi It looks like this breaks the main branch.
Could you move the job to a new file e.g. pr.yml and run it only for PRs and not main?