Skip to content

docs(tutorial): run Okteto Test in CI with GitHub Actions - #1368

Closed
ekline[bot] wants to merge 4 commits into
mainfrom
docs/tutorial/okteto-test-ci
Closed

ekline[bot] wants to merge 4 commits into
mainfrom
docs/tutorial/okteto-test-ci

Conversation

@ekline

@ekline ekline Bot commented Sep 30, 2026

Copy link
Copy Markdown
Contributor

Context

This how-to guide addresses a documentation gap identified through a tutorial/how-to gap review: competitor analysis (the given list: Coder, Ona/Gitpod, Qovery, Orca, Paseo, herdr, Signadot, Telepresence), persona needs, and a feature-coverage audit. The Okteto Test docs repeatedly state you can "run CI on Okteto" and "run tests in Preview Environments," and an okteto/test GitHub Action is listed in the reference, but no guide showed how to do it. The okteto/movies sample repo already wires this up in .github/workflows/preview.yaml, so the workflow existed in code but not in docs.

Top 3 gaps found

Rank Priority Gap Source Personas served Type
1 High No guide for running Okteto Test in a CI pipeline; docs promise "run CI on Okteto" but never show how, and the okteto/test Action is undocumented Competitor (Signadot "Set up Tests in CI"; Qovery "E2E Testing Ephemeral Environments with GitHub Actions") + feature-without-guide (Okteto Test) Developer, Platform/DevOps Engineer How-to
2 High No tutorial for developing a service locally against a shared cluster (Hybrid Mode), the core workflow of Signadot and Telepresence; Okteto has only a terse concept page Competitor (Signadot "Local Development"; Telepresence "Code and debug an application locally") Developer Tutorial
3 Medium No consolidated "Connect your IDE (VS Code / JetBrains Gateway)" how-to; Coder and Ona cover this extensively, Okteto scatters it across the SSH reference and per-language debug guides Competitor (Coder, Ona) Developer How-to

What this PR adds

A new how-to guide, "Running Okteto Test in CI," under the Okteto Test section. It shows how to run the test section of the Okteto Manifest on every pull request with GitHub Actions, against a Preview Environment, and export test results as build artifacts. It serves developers adopting Okteto Test and Platform/DevOps Engineers wiring up pipelines, and reuses the same okteto test suites developers already run locally. This PR also adds one cross-link from the getting-started guide and a sidebar entry.

Research sources

  • Competitor coverage: Signadot ("Set up Tests in CI", "Running Automated Tests") and Qovery ("Build E2E Testing Ephemeral Environments with GitHub Actions") both teach testing in CI/ephemeral environments; Okteto had no equivalent.
  • Feature grounding: the okteto/test GitHub Action inputs were taken from its action.yml (tests, namespace, name, file, deploy, no-cache, variables, timeout default 5m, log-level). The workflow pattern (deploy-preview + test + upload-artifact) is taken from the okteto/movies .github/workflows/preview.yaml.

Remaining gaps (follow-up work)

How to verify

  1. Run yarn build from docs/, which validates all links and anchors (this repo throws on broken links). Note: every internal link and anchor was verified manually against the source files, but yarn build could not be run locally because the Node toolchain was not reachable in the authoring environment.
  2. Run yarn start and open the Okteto Test section; confirm "Running Tests in CI" appears after "Getting Started with Okteto Test".
  3. Walk the guide against the okteto/movies repo: the workflow mirrors its .github/workflows/preview.yaml.

📝 Created with EkLine · View session

Signed-off-by: ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
@netlify

netlify Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for okteto-docs ready!

Name Link
🔨 Latest commit e56bcbc
🔍 Latest deploy log https://app.netlify.com/projects/okteto-docs/deploys/6ad078468bdd7f34514df552
😎 Deploy Preview https://deploy-preview-1368--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.

@ekline
ekline Bot requested a review from rberrelleza September 30, 2026 10:15
@ifbyol
ifbyol requested a balanced review from Copilot October 5, 2026 17:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The sample configuration and artifact paths need correction for the documented workflow to work.

Review effort: Balanced
Findings: 3 Medium severity

Open (3)
What changed in this PR

Adds a how-to guide for running Okteto Test in GitHub Actions against Preview Environments.

Changes:

  • Documents authentication, test execution, artifact uploads, and troubleshooting.
  • Adds a getting-started cross-link and sidebar entry.
File Description
src/​content/​testing/​run-tests-in-ci.mdx Adds the CI testing guide.
src/​content/​testing/​getting-started-test.mdx Links to the new guide.
sidebars.js Adds the guide under Okteto Test.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/content/testing/run-tests-in-ci.mdx Outdated
test:
e2e:
image: ghcr.io/okteto/playwright:chromium
context: e2e
Comment thread src/content/testing/run-tests-in-ci.mdx Outdated
ifbyol and others added 2 commits October 5, 2026 19:22
Clarify the purpose of the 'namespace' input and how to use it with Test Containers.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@pchico83

Copy link
Copy Markdown
Contributor

@ekline-ai pull from master, there is a new official release

…test-ci

Signed-off-by: ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
@ekline

ekline Bot commented Oct 15, 2026

Copy link
Copy Markdown
Contributor Author

Done — merged the latest main into this branch, which brings in the 1.49 release (#1375) and the other recent merges. No conflicts, and the PR now shows as mergeable.

The new guide stays in src/content/ (the next unreleased version) per the repo convention that all new content lands there, so it ships with the upcoming version rather than the frozen 1.49 snapshot. Happy to also backport it into versioned_docs/version-1.49/ if you'd like it live in the current official docs.

@ekline

ekline Bot commented Oct 15, 2026

Copy link
Copy Markdown
Contributor Author

Done. I handled the reviewer's request on PR #1368.

What I did

The comment "pull from master, there is a new official release" was a request to sync the branch, so I:

  1. Fetched and merged origin/main into docs/tutorial/okteto-test-ci. main had advanced 11 commits, including the 1.49 release (Release version 1.49 documentation #1375) — the "new official release" referenced.
  2. Resolved cleanly — the merge had no conflicts. All three of my changes survived intact: the new src/content/testing/run-tests-in-ci.mdx, the sidebar entry, and the getting-started cross-link. No conflict markers anywhere.
  3. Preserved the two maintainer tweaks already on the PR branch (wording and path edits to the new guide).
  4. Pushed the signed-off merge commit, updating the PR.
  5. Confirmed mergeability — the PR now reports MERGEABLE (the BLOCKED state is just the pending required review, not a conflict).
  6. Replied to the reviewer confirming the sync and noting that the new guide correctly lives in src/content/ (the next unreleased version) per the repo's convention — offering to backport into versioned_docs/version-1.49/ if they want it in the current official docs.

One note: I couldn't run yarn build to re-validate links (the Node toolchain isn't reachable in this environment), but the merge left my content files unchanged, so the links I verified manually earlier are unaffected.

pchico83 added a commit that referenced this pull request Oct 21, 2026
- Preview Environments: make the Preview Environment the place where automated
  tests run on every pull request or merge request. Shorten the index (How It
  Works and Getting Started) and add a Why Preview Environments page with
  diagrams about configuration drift, collaboration, and lighter CI jobs.
- GitHub Actions and GitLab CI/CD guides: rewrite both around the
  okteto/getting-started sample with the same steps: deploy the Preview
  Environment, configure credentials, open a pull or merge request, run the
  tests with okteto test, check the results, and clean up.
- Getting started guide: check out the tutorial branch, add a Test step, and
  mention other deploy tools and Docker Compose through new FAQs.
- Okteto Test: remove the testing pages and redirect them to Preview
  Environments and the new Test step. Update every docs version to the
  getting-started tutorial branch.

Replaces #1368.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Pablo Chico de Guzman <pchico83@gmail.com>
@pchico83

Copy link
Copy Markdown
Contributor

Closed in favor of #1387

@pchico83 pchico83 closed this Oct 21, 2026
@pchico83
pchico83 deleted the docs/tutorial/okteto-test-ci branch October 21, 2026 08:08
pchico83 added a commit that referenced this pull request Oct 21, 2026
- Preview Environments: make the Preview Environment the place where automated
  tests run on every pull request or merge request. Shorten the index (How It
  Works and Getting Started) and add a Why Preview Environments page with
  diagrams about configuration drift, collaboration, and lighter CI jobs.
- GitHub Actions and GitLab CI/CD guides: rewrite both around the
  okteto/getting-started sample with the same steps: deploy the Preview
  Environment, configure credentials, open a pull or merge request, run the
  tests with okteto test, check the results, and clean up.
- Getting started guide: check out the tutorial branch, add a Test step, and
  mention other deploy tools and Docker Compose through new FAQs.
- Okteto Test: remove the testing pages and redirect them to Preview
  Environments and the new Test step. Update every docs version to the
  getting-started tutorial branch.

Replaces #1368.

Signed-off-by: Pablo Chico de Guzman <pchico83@gmail.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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.

3 participants