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

Generate html preview of READMEs for PRs that change any of them #193

Merged
merged 26 commits into from
Mar 21, 2025

Conversation

bkabrda
Copy link
Collaborator

@bkabrda bkabrda commented Mar 20, 2025

The new workflow will:

  • Generate the HTML readmes in AAH style
  • Push them to a branch docspreview/pr-<PRnumber> (when followup changes are made to a PR, they will also get pushed to the branch)
  • If there are any changes in the generated HTML, it will add a comment that changes are ready with the links (see below)

The only downside is that we'll need to prune the docspreview branches manually from time to time, but that's ok (or we could create a workflow that would delete the branch when the PR is merged)

@securesign securesign deleted a comment from github-actions bot Mar 20, 2025
Copy link

Hi 👋 here are your HTML README previews:

Copy link

Hi 👋 here are your HTML README previews:

@bkabrda bkabrda marked this pull request as ready for review March 21, 2025 10:40
@bkabrda bkabrda requested a review from a team as a code owner March 21, 2025 10:40
Copy link
Collaborator

@SequeI SequeI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks Slavek!

@bkabrda bkabrda merged commit 1a7ccd7 into main Mar 21, 2025
6 checks passed
@bkabrda bkabrda deleted the slavek.kabrda/readme-preview branch March 21, 2025 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants