add files_renamed documentation

[808sAndBR]

Type of Change

• Documentation

Resolves

• Fixes Renamed files do not show as modified, added or removed, but do appear in files #108

Describe Changes

This will add clarity about the availability of files_renamed which I believe is causing the confusion people have voiced in #108 where it is not actually a bug, but just that it is not clear that this data is available. As far as I can tell (I don't actually know js/ts) the renamed files are getting added/processed here:

file-changes-action/src/FilesHelper.ts

Lines 24 to 30 in a6ca26c

	files.forEach(f => {
	changedFiles[f.status].push(
	f.filename || f.added || f.removed || f.renamed || f.modified
	)
	changedFiles.files.push(
	f.filename || f.added || f.removed || f.modified || f.renamed
	)

and when I test trying to access the files_renamed object in my code that leverages this action it works as expected.

[remisalmon]

Thanks for opening this PR, outputs.files_renamed works as expected for me. Would be great to see this merged.

[808sAndBR]

Hi @trilom just noticed this still open and wanted to check if there is anything useful I can do on my end. Thanks!