Skip to content

📖 docs: document E2E workaround for kubeflex context issue #525

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.

Sign up for GitHub

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

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

📖 docs: document E2E workaround for kubeflex context issue #525

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c33f52
docs: document E2E workaround for kubeflex context issue
mrhapile Jan 9, 2026
0c3b20e
docs: document minor fix
mrhapile Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,16 @@ Open a Pull Request (PR) from your branch to the main repository.
- **Respect Internationalization Standards:** Avoid pushing raw UI strings directly; always use i18n references.
- **Be Respectful:** Review our Code of Conduct before contributing.

## Note on E2E Test Context Workaround

The E2E test suite includes a temporary workaround for a known kubeflex context-selection issue.

Under certain conditions, `kflex create` can select an unintended hosting cluster when multiple kubeconfig contexts are present and kubeflex-related context extensions are configured. This can cause E2E tests to fail even when the current context correctly accesses the intended hosting cluster.

To ensure consistent and reliable test execution, the E2E test setup removes kubeflex-specific extensions from the kubeconfig before running tests. This forces `kflex create` to rely solely on the current kubeconfig context during E2E runs.

This workaround is limited to the E2E test infrastructure and does not affect normal user workflows. It is intended to be temporary and will be removed once the underlying context-handling issue is resolved.

### Caution With AI-Generated Code

> AI tools (like GitHub Copilot or ChatGPT) are helpful but **not always context-aware**.
Expand Down