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

Report doc preview status in PRs #8014

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open

Report doc preview status in PRs #8014

wants to merge 28 commits into from

Conversation

jprochazk
Copy link
Member

@jprochazk jprochazk commented Nov 6, 2024

What

This is part 1 of documentation preview improvements.

  • Add ability to wait for deployment to .github/actions/vercel
  • Report current status in the PR comment
  • Test all failure paths

Output examples

image

image

image

image

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

@jprochazk jprochazk added 📖 documentation Improvements or additions to documentation exclude from changelog PRs with this won't show up in CHANGELOG.md 🚢 CI labels Nov 6, 2024
Copy link

github-actions bot commented Nov 6, 2024

Latest documentation preview deployed successfully.

Result Commit Link
7ca5cbb https://landing-62kdd1rre-rerun.vercel.app/docs

Note: This comment is updated whenever you push a commit.

@jprochazk jprochazk marked this pull request as draft November 6, 2024 10:35
@jprochazk jprochazk changed the title Improve documentation previews Report doc preview status in PRs Nov 6, 2024
@jprochazk jprochazk marked this pull request as ready for review November 6, 2024 11:55
@Wumpf Wumpf self-requested a review November 6, 2024 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation exclude from changelog PRs with this won't show up in CHANGELOG.md 🚢 CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant