Repository navigation
docs(tutorial): run Okteto Test in CI with GitHub Actions - #1368
ekline[bot] wants to merge 4 commits into
Conversation
Signed-off-by: ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
✅ Deploy Preview for okteto-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The sample configuration and artifact paths need correction for the documented workflow to work.
Review effort: Balanced
Findings: 3
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.
| test: | ||
| e2e: | ||
| image: ghcr.io/okteto/playwright:chromium | ||
| context: e2e |
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>
|
@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>
|
Done — merged the latest The new guide stays in |
|
Done. I handled the reviewer's request on PR #1368. What I didThe comment "pull from master, there is a new official release" was a request to sync the branch, so I:
One note: I couldn't run |
- 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>
|
Closed in favor of #1387 |
- 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>

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/testGitHub 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
okteto/testAction is undocumentedWhat this PR adds
A new how-to guide, "Running Okteto Test in CI," under the Okteto Test section. It shows how to run the
testsection 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 sameokteto testsuites developers already run locally. This PR also adds one cross-link from the getting-started guide and a sidebar entry.Research sources
okteto/testGitHub Action inputs were taken from itsaction.yml(tests,namespace,name,file,deploy,no-cache,variables,timeoutdefault5m,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)
npm link#2: A tutorial on developing a service locally against a shared cluster with Hybrid Mode.How to verify
yarn buildfromdocs/, 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, butyarn buildcould not be run locally because the Node toolchain was not reachable in the authoring environment.yarn startand open the Okteto Test section; confirm "Running Tests in CI" appears after "Getting Started with Okteto Test"..github/workflows/preview.yaml.📝 Created with EkLine · View session