Skip to content

Add preview environments tutorial#1198

Open
ekline[bot] wants to merge 1 commit into
mainfrom
docs/tutorial-preview-environments
Open

Add preview environments tutorial#1198
ekline[bot] wants to merge 1 commit into
mainfrom
docs/tutorial-preview-environments

Conversation

@ekline
Copy link
Copy Markdown
Contributor

@ekline ekline Bot commented Apr 14, 2026

Summary

  • Adds a new end-to-end tutorial for Preview Environments using GitHub Actions and the Movies sample app
  • Covers the full PR-to-preview-to-merge lifecycle: deploy workflow, cleanup workflow, and automated Playwright e2e tests via okteto/test
  • Registers the tutorial in sidebarTutorials.js (positioned after the getting-started tutorial)

This was the #1 high-priority gap identified in the tutorial coverage audit. Preview Environments are a core selling point but had no hands-on tutorial — only a how-to guide that skipped testing integration and the full lifecycle.

What the tutorial covers (8 steps)

  1. Fork the Movies sample app
  2. Configure GitHub secrets (OKTETO_TOKEN, OKTETO_CONTEXT)
  3. Create the deploy workflow (okteto/deploy-preview)
  4. Add end-to-end tests (okteto/test with Playwright)
  5. Create the cleanup workflow (okteto/destroy-preview)
  6. Open a pull request
  7. Verify the preview environment (PR comment with URL, test results)
  8. Merge and clean up

Key additions beyond the existing how-to guide

  • Full PR → preview → test → merge → cleanup lifecycle
  • okteto/test integration (absent from the existing how-to)
  • Concurrency best practices and scope: global guidance
  • Test artifact upload for debugging

Test plan

  • Run yarn build from docs/ to validate no broken links or anchors
  • Verify sidebar renders the new tutorial in the correct position
  • Confirm both referenced images (preview-check.png, preview-message.png) display correctly
  • Verify all internal links resolve

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>

New tutorial walks developers through the complete PR-to-preview-to-merge
lifecycle using GitHub Actions and the Movies sample app. Covers deploy
workflow, cleanup workflow, and automated Playwright e2e tests — filling
the top gap identified in the tutorial coverage audit.

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 14, 2026

Deploy Preview for okteto-docs ready!

Name Link
🔨 Latest commit edc3239
🔍 Latest deploy log https://app.netlify.com/projects/okteto-docs/deploys/69deabc5e37fea0008f872bb
😎 Deploy Preview https://deploy-preview-1198--okteto-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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.

0 participants