Skip to content
This repository was archived by the owner on Jul 2, 2026. It is now read-only.

Fix E2E skip logic #5

Merged
arran4 merged 1 commit into from
Jun 26, 2025
Merged

Fix E2E skip logic #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 2 additions & 6 deletions .github/workflows/e2e.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,30 +27,26 @@ jobs:
echo "run=true" >> "$GITHUB_OUTPUT"
fi
- name: Checkout repository
if: steps.check.outputs.run == 'true'
uses: actions/checkout@v4

- name: Set up Node.js
if: steps.check.outputs.run == 'true'
uses: actions/setup-node@v4
with:
node-version: 20.x
cache: 'npm'

- name: Install dependencies
if: steps.check.outputs.run == 'true'
run: npm ci

- name: Build project
if: steps.check.outputs.run == 'true'
run: npm run build

- name: Set up Docker
if: steps.check.outputs.run == 'true' && matrix.sandbox == 'sandbox:docker'
if: matrix.sandbox == 'sandbox:docker'
uses: docker/setup-buildx-action@v3

- name: Set up Podman
if: steps.check.outputs.run == 'true' && matrix.sandbox == 'sandbox:podman'
if: matrix.sandbox == 'sandbox:podman'
uses: redhat-actions/podman-login@v1
with:
registry: docker.io
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ In the PR description, explain the "why" behind your changes and link to the rel

## Forking

If you are forking the repository you will be able to run the Build, Test and Integration test workflows. However, in order to make the integration tests run you'll need to add a [GitHub Repository Secret](<[url](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository)>) with a value of `GEMINI_API_KEY` and set that to a valid API key that you have available. Your key and secret are private to your repo; no one without access can see your key and you cannot see any secrets related to this repo. If you do not want the integration tests to run, create a secret named `E2E_SKIP` with the value `true`. The workflow checks both `GEMINI_API_KEY` and `E2E_SKIP` before running and skips the E2E tests when `E2E_SKIP` is `true` or no API key is provided.
If you are forking the repository you will be able to run the Build, Test and Integration test workflows. However, in order to make the integration tests run you'll need to add a [GitHub Repository Secret](<[url](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository)>) with a value of `GEMINI_API_KEY` and set that to a valid API key that you have available. Your key and secret are private to your repo; no one without access can see your key and you cannot see any secrets related to this repo. If you do not want the integration tests to run, create a secret named `E2E_SKIP` with the value `true`. The workflow checks both `GEMINI_API_KEY` and `E2E_SKIP` before running and skips only the E2E test step when `E2E_SKIP` is `true` or no API key is provided.

Additionally you will need to click on the `Actions` tab and enable workflows for your repository, you'll find its the large blue button in the center of the screen.

Expand Down
2 changes: 1 addition & 1 deletion docs/integration-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ This structure makes it easy to locate the artifacts for a specific test run, fi

## Continuous integration

To ensure the integration tests are always run, a GitHub Actions workflow is defined in `.github/workflows/e2e.yml`. This workflow automatically runs the integration tests on every pull request and push to the `main` branch. The tests require a valid `GEMINI_API_KEY` secret. If you do not want the tests to run (for example in a fork where you may not have an API key), create a repository secret named `E2E_SKIP` set to `true`. The workflow skips execution when `E2E_SKIP` is `true`.
To ensure the integration tests are always run, a GitHub Actions workflow is defined in `.github/workflows/e2e.yml`. This workflow automatically runs the integration tests on every pull request and push to the `main` branch. The tests require a valid `GEMINI_API_KEY` secret. If you do not want the tests to run (for example in a fork where you may not have an API key), create a repository secret named `E2E_SKIP` set to `true`. The workflow still builds the project but skips the E2E test step when `E2E_SKIP` is `true`.

The workflow runs the tests in different sandboxing environments to ensure Gemini CLI is tested across each:

Expand Down