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

[WIP] Workflow for Preview System #1931

Merged
merged 10 commits into from
May 20, 2024
Merged

[WIP] Workflow for Preview System #1931

merged 10 commits into from
May 20, 2024

Conversation

lukdog
Copy link
Member

@lukdog lukdog commented May 8, 2024

What This PR Changes

This PR introduces a preview system for Arduino Docs. The preview system is PR based and it is necessary to display a preview of the content created or modified in a pull request.

The preview is built on Github using the same tools and environment used for staging and production builds. When the build is completed the generated files are deployed on Netlify and a preview url is returned. A comment is added to the PR with the preview URL and related SHA.

The preview is not built automatically for each PR, if a user need the preview a specific label should be added: preview. If the label is present, every-time the PR is modified also the preview is updated.

Contribution Guidelines

@lukdog lukdog added the preview label May 8, 2024
Copy link

github-actions bot commented May 8, 2024

Preview Deployment

🚀 Preview this PR: https://664b4bad11b525c08f6c11c9--docs-content.netlify.app
📍 Commit SHA: bd72bae

@lukdog lukdog force-pushed the vercel-preview branch from f5720a2 to 960dba9 Compare May 8, 2024 13:37
@lukdog lukdog self-assigned this May 8, 2024
@lukdog lukdog force-pushed the vercel-preview branch from 90c28f1 to 98aebe1 Compare May 9, 2024 13:24
@arduino arduino deleted a comment from github-actions bot May 9, 2024
@lukdog lukdog marked this pull request as ready for review May 9, 2024 13:45
@lukdog lukdog requested review from Matteo-it and jhansson-ard May 20, 2024 12:25
README.md Outdated Show resolved Hide resolved
Co-authored-by: Josefine Herlin <[email protected]>
@lukdog lukdog merged commit 0d12f94 into main May 20, 2024
4 checks passed
@lukdog lukdog deleted the vercel-preview branch May 20, 2024 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants