{"id":18420376,"url":"https://github.com/kubeshop/setup-testkube","last_synced_at":"2025-04-07T13:31:58.904Z","repository":{"id":197215595,"uuid":"698154073","full_name":"kubeshop/setup-testkube","owner":"kubeshop","description":"GitHub Action to set up the Testkube CLI","archived":false,"fork":false,"pushed_at":"2025-02-07T07:24:38.000Z","size":569,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-22T19:24:03.422Z","etag":null,"topics":["automation","cicd","github-actions","test-automation","testing"],"latest_commit_sha":null,"homepage":"https://docs.testkube.io/articles/github-actions","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kubeshop.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-29T09:24:44.000Z","updated_at":"2025-02-07T12:50:57.000Z","dependencies_parsed_at":"2024-08-14T16:24:31.788Z","dependency_job_id":null,"html_url":"https://github.com/kubeshop/setup-testkube","commit_stats":null,"previous_names":["kubeshop/setup-testkube"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubeshop%2Fsetup-testkube","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubeshop%2Fsetup-testkube/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubeshop%2Fsetup-testkube/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubeshop%2Fsetup-testkube/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kubeshop","download_url":"https://codeload.github.com/kubeshop/setup-testkube/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247661838,"owners_count":20975132,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","cicd","github-actions","test-automation","testing"],"created_at":"2024-11-06T04:21:24.201Z","updated_at":"2025-04-07T13:31:55.789Z","avatar_url":"https://github.com/kubeshop.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/testkube-logo.svg\" alt=\"Testkube Logo\" width=\"80\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Welcome to Testkube - Your friendly cloud-native testing framework for Kubernetes\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://testkube.io\"\u003eWebsite\u003c/a\u003e |\n  \u003ca href=\"https://kubeshop.github.io/testkube\"\u003eDocumentation\u003c/a\u003e |\n  \u003ca href=\"https://twitter.com/testkube_io\"\u003eTwitter\u003c/a\u003e |\n  \u003ca href=\"https://discord.gg/hfq44wtR6Q\"\u003eDiscord\u003c/a\u003e |\n  \u003ca href=\"https://kubeshop.io/category/testkube\"\u003eBlog\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg title=\"MIT license\" src=\"https://img.shields.io/badge/License-MIT-yellow.svg\"/\u003e\n  \u003ca href=\"https://github.com/kubeshop/setup-testkube/releases\"\u003e\u003cimg title=\"Release\" src=\"https://img.shields.io/github/v/release/kubeshop/setup-testkube\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/kubeshop/setup-testkube/releases\"\u003e\u003cimg title=\"Release date\" src=\"https://img.shields.io/github/release-date/kubeshop/setup-testkube\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003chr\u003e\n\n# Setup Testkube CLI with GitHub Actions\n\n\"Setup Testkube CLI\" is a GitHub Action for managing your Testkube installation.\n\nUse it to install Testkube CLI to manage your resources, run tests and test suites, or anything else.\n\n## Table of content\n\n1. [Usage](#usage)\n   1. [Testkube Pro](#testkube-pro)\n   2. [Self-hosted instance](#self-hosted-instance)\n   3. [Examples](#examples)\n      1. [Run a test on AWS EKS](#run-a-test-on-aws-eks)\n      2. [Run a test on the Pro instance](#run-a-test-on-the-pro-instance)\n2. [Inputs](#inputs)\n   1. [Common](#common)\n   2. [Kubernetes (`kubectl`)](#kubernetes-kubectl)\n   3. [Pro and Enterprise](#pro-and-enterprise)\n\n## Usage\n\nTo use the action in your GitHub workflow, use `kubeshop/setup-testkube@v1` action.\nThe configuration options are described in the [**Inputs**](#inputs) section, and may vary depending on the Testkube solution you are using ([**Pro**](#pro) or [**self-hosted**](#self-hosted-instance)) and your needs.\n\n### Testkube Pro\n\nTo use this GitHub Action for the [**Testkube Pro**](https://app.testkube.io), you need to [**create API token**](https://docs.testkube.io/testkube-pro/organization-management#api-tokens).\n\nThen, pass the `organization` and `environment` IDs for the test, along with the `token` and other parameters specific for your use case:\n\n```yaml\nuses: kubeshop/setup-testkube@v1\nwith:\n  # Instance\n  organization: tkcorg_0123456789abcdef\n  environment: tkcenv_fedcba9876543210\n  token: tkcapi_0123456789abcdef0123456789abcd\n```\n\nIt will be probably unsafe to keep directly in the workflow's YAML configuration, so you may want to use [**Github's secrets**](https://docs.github.com/en/actions/security-guides/encrypted-secrets) instead.\n\n```yaml\nuses: kubeshop/setup-testkube@v1\nwith:\n  # Instance\n  organization: ${{ secrets.TkOrganization }}\n  environment: ${{ secrets.TkEnvironment }}\n  token: ${{ secrets.TkToken }}\n```\n\n### Self-hosted instance\n\nTo connect to the self-hosted instance, you need to have `kubectl` configured for accessing your Kubernetes cluster, and simply passing optional namespace, if the Testkube is not deployed in the default `testkube` namespace, i.e.:\n\n```yaml\nuses: kubeshop/setup-testkube@v1\nwith:\n  namespace: custom-testkube\n```\n\n### Examples\n\n#### Run a test on AWS EKS\n\n```yaml\nsteps:\n  # Set up Kubectl (AWS EKS)\n  - uses: aws-actions/configure-aws-credentials@v4\n    with:\n      aws-access-key-id: ${{ secrets.AwsAccessKeyId }}\n      aws-secret-access-key: ${{ secrets.AwsSecretAccessKey }}\n      aws-region: ${{ secrets.AwsRegion }}\n  - run: |\n      aws eks update-kubeconfig --name ${{ secrets.EksClusterName }} --region ${{ secrets.AwsRegion }}\n\n  # Setup Testkube\n  - uses: kubeshop/setup-testkube@v1\n\n  # Use CLI with a shell script\n  - run: |\n      testkube run test some-test-name -f\n```\n\n#### Run a test on the Pro instance\n\n```yaml\nsteps:\n  # Setup Testkube\n  - uses: kubeshop/setup-testkube@v1\n    with:\n      organization: ${{ secrets.TkOrganization }}\n      environment: ${{ secrets.TkEnvironment }}\n      token: ${{ secrets.TkToken }}\n\n  # Use CLI with a shell script\n  - run: |\n      testkube run test some-test-name -f\n```\n\n## Inputs\n\nBesides common inputs, there are some different for kubectl and Pro connection.\n\n### Common\n\n| Required | Name              | Description                                                                                                                  |\n|:--------:|-------------------|------------------------------------------------------------------------------------------------------------------------------|\n|    ✗     | `channel`         | Distribution channel to install the latest application from - one of `stable` or `beta` (default: `stable`)                  |\n|    ✗     | `version`         | Static Testkube CLI version to force its installation instead of the latest                                                  |\n\n### Kubernetes (`kubectl`)\n\n| Required | Name           | Description                                                                            |\n|:--------:|----------------|----------------------------------------------------------------------------------------|\n|    ✗     | `namespace`    | Set namespace where Testkube is deployed to (default: `testkube`)                      |\n\n### Pro and Enterprise\n\n| Required | Name               | Description                                                                                                                                                                                                                           |\n|:--------:|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|    ✓     | `organization`     | The organization ID from Testkube Pro or Enterprise - it starts with `tkc_org`, you may find it i.e. in the dashboard's URL                                                                                                           |\n|    ✓     | `environment`      | The environment ID from Testkube Pro or Enterprise - it starts with `tkc_env`, you may find it i.e. in the dashboard's URL                                                                                                            |\n|    ✓     | `token`            | API token that has at least a permission to run specific test or test suite. You may read more about [**creating API token**](https://docs.testkube.io/testkube-pro/organization-management#api-tokens) in Testkube Pro or Enterprise |\n|    ✗     | `url`              | URL of the Testkube Enterprise instance, if applicable                                                                                                                                                                                |\n|    ✗     | `urlApiSubdomain`  | API subdomain the Testkube Enterprise URL, if necessary                                                                                                                                                                               |\n|    ✗     | `urlUiSubdomain`   | Dashboard subdomain the Testkube Enterprise URL, if necessary                                                                                                                                                                         |\n|    ✗     | `urlLogsSubdomain` | Logs Server subdomain the Testkube Enterprise URL, if necessary                                                                                                                                                                       |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubeshop%2Fsetup-testkube","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubeshop%2Fsetup-testkube","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubeshop%2Fsetup-testkube/lists"}