Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a list of (changed) rendered files to the "docs emitted" PR comment #2646

Closed
AetherUnbound opened this issue Jul 14, 2023 · 0 comments · Fixed by #2647
Closed

Add a list of (changed) rendered files to the "docs emitted" PR comment #2646

AetherUnbound opened this issue Jul 14, 2023 · 0 comments · Fixed by #2647
Assignees
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

Comments

@AetherUnbound
Copy link
Collaborator

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:

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:

- name: Replace preview of current PR
if: github.event_name == 'pull_request'
run: |
cp -r . /tmp/gh-pages
sudo rm -rf /tmp/gh-pages/_preview/${{ github.event.pull_request.number }}
mv /tmp/docs /tmp/gh-pages/_preview/${{ github.event.pull_request.number }}

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".

@AetherUnbound AetherUnbound added 🌟 goal: addition Addition of new feature 🔧 tech: github actions Involves Github Actions 🟩 priority: low Low priority and doesn't need to be rushed 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations labels Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant