Add a list of (changed) rendered files to the "docs emitted" PR comment #2646
Labels
🤖 aspect: dx
Concerns developers' experience with the codebase
🌟 goal: addition
Addition of new feature
🟩 priority: low
Low priority and doesn't need to be rushed
🧱 stack: mgmt
Related to repo management and automations
🔧 tech: github actions
Involves Github Actions
Description
Presently we have a step in our CI/CD which builds the docs in a preview directory, then emits a message saying as much with a path to the main preview page:
openverse/.github/workflows/ci_cd.yml
Line 769 in 399036e
Recently, @obulat added an edited note on the comment to help community contributors view the rendered project plan easier: #2637 (comment)
It would be ideal if we could generate a list of the doc files which have been changed or differ from
main
, and then display that inside the comment as well. This might be possible using simple directory diffing at this step:openverse/.github/workflows/ci_cd.yml
Lines 824 to 829 in 399036e
We'd need to account for scenarios which potentially change all (dozens at this point?) of the files in the docs directory. Perhaps we after a certain limit we can emit a message that says "too many files changed to reference each individually".
The text was updated successfully, but these errors were encountered: