diff --git a/src/content/docs/integrations/continuous-integration/github.md b/src/content/docs/integrations/continuous-integration/github.md index a8501ba9..3c91c407 100644 --- a/src/content/docs/integrations/continuous-integration/github.md +++ b/src/content/docs/integrations/continuous-integration/github.md @@ -7,23 +7,27 @@ head: - tag: meta attrs: name: keywords - content: GitHub, Testomat.io, CI connection, CI Integration, GitHub Actions, Personal Access Token, Continuous Integration, Test Automation, Test Management, input parameters, environment variables, API token, Workflow, test reporting + content: GitHub, GitHub Enterprise, GitHub Enterprise Cloud, GitHub Enterprise Server, Testomat.io, CI connection, CI Integration, GitHub Actions, Personal Access Token, Continuous Integration, Test Automation, Test Management, input parameters, environment variables, API token, Workflow, test reporting --- To set up connection between GitHub and Testomat.io, first, you need to configure your GitHub account: -1. Create a Personal Access Token on GitHub with access to workflow scope (follow the instructions by link - [Create PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)). +Create a Personal Access Token on GitHub with access to workflow scope (follow the instructions by link - [Create PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)). -![Testomatio - GitHub](./images/Github_1.png) +![Testomatio - GitHub](./images/github/1-create-token.png) -2. Create a Workflow in a GitHub Repository: Go to **'Actions'** tab in Repository -> Select Workflow template -> Click **'Configure'** button. Then you will get a workflow template. -**A workflow filename will be used by Testomat.io to call a specific workflow.** +Create a Workflow in a GitHub Repository: +1. Go to **'Actions'** tab in Repository +2. Select Workflow template +3. Click **'Configure'** button. Then you will get a workflow template. -![Testomatio - GitHub](./images/Github_2.png) +:::note + +A workflow filename will be used by Testomat.io to call a specific workflow. -![Testomatio - GitHub](./images/Github_3.png) +::: -3. This workflow will be used solely by Testomat.io, so it should start only on `workflow_dispatch` event. The event should be defined with the following input parameters: +This workflow will be used solely by Testomat.io, so it should start only on `workflow_dispatch` event. The event should be defined with the following input parameters: ```yaml name: Testomatio Tests @@ -41,7 +45,7 @@ on: required: false ``` -4. The **Job** should include a step where the test runner is executed with `--grep` option and `TESTOMATIO` environment variables passed in. For instance: +The **Job** should include a step where the test runner is executed with `--grep` option and `TESTOMATIO` environment variables passed in. For instance: ```yaml - run: npx codeceptjs run --grep "${{ github.event.inputs.grep }}" @@ -56,22 +60,22 @@ After configuring your GitHub account, integrate GitHub Actions CI with your Tes 2. Select **'Continuous Integration'**. 3. Click **'Connect to CI'**. -![Testomatio - CI](./images/CI_4.png) +![Testomatio - CI](./images/github/2-connect-ci.png) -4. Select **'GitHub'** and enter following details on the **'Connection'** tab: +Then, select **'GitHub'** and enter following details on the **'Connection'** tab: - `GitHub Username`. - `API token` - PAT created, in GitHub during Step 1. - `Organization/Repository (or User/Repository)`. - `Workflow` - name of a workflow in GitHub Actions, in our case `testomatio.yml`. -![Testomatio - GitHub](./images/Github_4.png) +![Testomatio - GitHub](./images/github/3-enter-ci-credentials.png) -5. Open **'Configuration'** tab and check the default `ref` value. `ref` specifies the target branch or tag for test execution. By default, it is set to `master`, but you can adjust this if your main branch uses a different name, such as `main`. +Open **'Configuration'** tab and check the default `ref` value. `ref` specifies the target branch or tag for test execution. By default, it is set to `master`, but you can adjust this if your main branch uses a different name, such as `main`. -![Testomatio - GitHub](./images/Github_5.png) +![Testomatio - GitHub](./images/github/4-configure-ci-connection.png) -6. Go to **'Input Variables'** tab and enable `run` and `testomatio` inputs, to pass them from Testomat.io. +Go to **'Input Variables'** tab and enable `run` and `testomatio` inputs, to pass them from Testomat.io. :::note @@ -85,11 +89,11 @@ The `ref` parameter specifies which branch to run the workflow on. The provided ::: -7. Click on **'Save'** button to save the connection. +Click on **'Save'** button to save the connection. -![Testomatio - GitHub](./images/Github_6.png) +![Testomatio - GitHub](./images/github/5-pass-input-variables.png) -8a. When the connection is saved, open **'Runs'** page and select `Run Automated Tests in CI` option in extra menu. +When the connection is saved, open **'Runs'** page and select `Run Automated Tests in CI` option in extra menu. :::note @@ -97,24 +101,47 @@ When using the "Test connection" button, workflow lookup is performed against th ::: -![Testomatio - CI Run](./images/CI_Run_2.png) +![Testomatio - CI Run](./images/github/6-new-auto-run-on-ci.png) -9a. Select **'GitHub'** profile in a list, select a target ref and any other variables, if any were configured. Optionally, select a **Test Plan** or create a new one. +Select **'GitHub'** profile in a list, select a target ref and any other variables, if any were configured. Optionally, select a **Test Plan** or create a new one. -10a. Click on **'Launch'** button and wait for the results. +Click on **'Launch'** button and wait for the results. -![Testomatio - GitHub](./images/Github_7.png) +![Testomatio - GitHub](./images/github/7-setup-ci-auto-run.png) -OR +Alternatively, follow these steps: -8b. On **'Tests'** page select any automated suite or test case -> click **'Extra menu'** button -> select **'Run Tests'** option -> open **'Run in CI'** tab. +1. On **'Tests'** page select any automated suite or test case. +2. Click **'Extra menu'** button. +3. Select **'Run Tests'** option. +4. Open **'Run in CI'** tab. +5. Select **'GitHub'** profile in a list, a target ref, and any other variables +6. Click on **'Launch'** button and wait for the results. -9b. Select **'GitHub'** profile in a list, as well, select a target ref and any other variables, if any were configured. +![Testomatio - GitHub](./images/github/8-create-ci-run-suite.png) -10b. Click on **'Launch'** button and wait for the results. +This will start a new job in GitHub Actions, please check that the job was successfully triggered and completed. After the job has finished, a run report will be available on Runs page of Testomat.io. -![Testomatio - GitHub](./images/Github_7b.gif) +![Testomatio - GitHub](./images/github/9-ci-run-finished.png) -This will start a new job in GitHub Actions, please check that the job was successfully triggered and completed. After the job has finished, a run report will be available on Runs page of Testomat.io. +## Connect GitHub Enterprise + +If your repository is on GitHub Enterprise Cloud (`*.ghe.com`) or GitHub Enterprise Server, use the **GitHub Enterprise** integration instead of **GitHub**. It sends requests to your company's GitHub, not to github.com. + +Set up the workflow and the access token in your GitHub Enterprise as described above, then: + +1. Go to **Settings** → **Continuous Integration** and click **Connect to CI**. +2. Select **GitHub Enterprise**. +3. In **GitHub Enterprise API URL**, enter the API address of your GitHub: + - GitHub Enterprise Cloud with data residency: `https://api..ghe.com`; + - GitHub Enterprise Server: `https://github..com/api/v3`. +4. Fill in **GitHub Username**, **API Token**, **Organization/Repository**, and **Workflow**, the same as for GitHub. +5. Click **Save**. + +The next steps (configuration, input variables, and launching runs) are the same as for GitHub. + +## Next Steps -![Testomatio - GitHub](./images/Github_8.png) +- [Continuous Integration](/integrations/continuous-integration/) +- [Running Automated Tests](/project/runs/running-automated-tests/) +- [GitHub Issues Configuration](/integrations/issues-management/github/) diff --git a/src/content/docs/integrations/continuous-integration/images/github/1-create-token.png b/src/content/docs/integrations/continuous-integration/images/github/1-create-token.png new file mode 100644 index 00000000..952724b0 Binary files /dev/null and b/src/content/docs/integrations/continuous-integration/images/github/1-create-token.png differ diff --git a/src/content/docs/integrations/continuous-integration/images/github/2-connect-ci.png b/src/content/docs/integrations/continuous-integration/images/github/2-connect-ci.png new file mode 100644 index 00000000..0c09e666 Binary files /dev/null and b/src/content/docs/integrations/continuous-integration/images/github/2-connect-ci.png differ diff --git a/src/content/docs/integrations/continuous-integration/images/github/3-enter-ci-credentials.png b/src/content/docs/integrations/continuous-integration/images/github/3-enter-ci-credentials.png new file mode 100644 index 00000000..8d81107a Binary files /dev/null and b/src/content/docs/integrations/continuous-integration/images/github/3-enter-ci-credentials.png differ diff --git a/src/content/docs/integrations/continuous-integration/images/github/4-configure-ci-connection.png b/src/content/docs/integrations/continuous-integration/images/github/4-configure-ci-connection.png new file mode 100644 index 00000000..b193e250 Binary files /dev/null and b/src/content/docs/integrations/continuous-integration/images/github/4-configure-ci-connection.png differ diff --git a/src/content/docs/integrations/continuous-integration/images/github/5-pass-input-variables.png b/src/content/docs/integrations/continuous-integration/images/github/5-pass-input-variables.png new file mode 100644 index 00000000..b7b4c12b Binary files /dev/null and b/src/content/docs/integrations/continuous-integration/images/github/5-pass-input-variables.png differ diff --git a/src/content/docs/integrations/continuous-integration/images/github/6-new-auto-run-on-ci.png b/src/content/docs/integrations/continuous-integration/images/github/6-new-auto-run-on-ci.png new file mode 100644 index 00000000..2c34fed2 Binary files /dev/null and b/src/content/docs/integrations/continuous-integration/images/github/6-new-auto-run-on-ci.png differ diff --git a/src/content/docs/integrations/continuous-integration/images/github/7-setup-ci-auto-run.png b/src/content/docs/integrations/continuous-integration/images/github/7-setup-ci-auto-run.png new file mode 100644 index 00000000..79293b09 Binary files /dev/null and b/src/content/docs/integrations/continuous-integration/images/github/7-setup-ci-auto-run.png differ diff --git a/src/content/docs/integrations/continuous-integration/images/github/8-create-ci-run-suite.png b/src/content/docs/integrations/continuous-integration/images/github/8-create-ci-run-suite.png new file mode 100644 index 00000000..6cafda90 Binary files /dev/null and b/src/content/docs/integrations/continuous-integration/images/github/8-create-ci-run-suite.png differ diff --git a/src/content/docs/integrations/continuous-integration/images/github/9-ci-run-finished.png b/src/content/docs/integrations/continuous-integration/images/github/9-ci-run-finished.png new file mode 100644 index 00000000..3c702957 Binary files /dev/null and b/src/content/docs/integrations/continuous-integration/images/github/9-ci-run-finished.png differ diff --git a/src/content/docs/integrations/continuous-integration/index.mdx b/src/content/docs/integrations/continuous-integration/index.mdx index 793d9962..e3e8d2b7 100644 --- a/src/content/docs/integrations/continuous-integration/index.mdx +++ b/src/content/docs/integrations/continuous-integration/index.mdx @@ -7,7 +7,7 @@ head: - tag: meta attrs: name: keywords - content: Testomat.io, Continuous Integration, CI connection, CI Integration, CI/CD, test automation, test management, Jenkins, Atlassian Bamboo, BitBucket Pipelines, TeamCity, GitHub Actions, GitLab CI, Circle CI, Azure Pipelines, automated testing, CI tools, CI job, testing workflow, test reports, input variables, environment configuration, custom variables + content: Testomat.io, Continuous Integration, CI connection, CI Integration, CI/CD, test automation, test management, Jenkins, Atlassian Bamboo, BitBucket Pipelines, TeamCity, GitHub Actions, GitHub Enterprise, GitLab CI, Circle CI, Azure Pipelines, automated testing, CI tools, CI job, testing workflow, test reports, input variables, environment configuration, custom variables --- import DirectoryLinks from '/src/components/DirectoryLinks.astro'; diff --git a/src/content/docs/integrations/issues-management/github.md b/src/content/docs/integrations/issues-management/github.md index 28891802..4646c3cb 100644 --- a/src/content/docs/integrations/issues-management/github.md +++ b/src/content/docs/integrations/issues-management/github.md @@ -12,20 +12,26 @@ head: - tag: meta attrs: name: keywords - content: GitHub Issues, Testomat.io, issue tracking, test management, API token, workflow integration, defect creation, test reporting + content: GitHub Issues, GitHub Enterprise, Testomat.io, issue tracking, test management, API token, workflow integration, defect creation, test reporting --- -![CleanShot 2022-11-19 at 18 56 02@2x](./images/202862519-e99c8c8d-7166-4c46-8a66-bc3496bb98bb.jpg) +![Connect GitHub Issues in five steps: name the profile, enter your username, add the API token, enter the repository, and click Save. Testomat.io and GitHub are then connected](./images/github/0-connect-github-steps.png) 1. Give a name to your profile -4. Enter your GitHub Username -8. Enter your GitHub API Token with access to workflow scope and write permissions ([learn more](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)) -![Alt text](./images/GH-pat.png) -10. Enter your GitHub Organization/Repository -11. Click on Save button +2. Enter your GitHub Username +3. Enter your GitHub API Token with access to workflow scope and write permissions ([learn more](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)) +4. Enter your GitHub Organization/Repository +5. Click on Save button -![CleanShot 2022-11-19 at 18 58 12@2x](./images/202862612-68c32b53-ed91-4e34-98cb-6125c3bccc6c.jpg) +![Connecting the GitHub profile to Testomat.io with the form's fields filled out](./images/github/1-connect-github.png) Once your Issues Management System is configured you can link a test or create a defect. As a result, Testomat.io will create a ticket in your GitHub project with dedicated links and data, so you can easily look through the testing data you need. Here is an example: -![CleanShot 2022-11-23 at 16 29 39@2x](./images/203572256-7081ae0b-a2f2-48f6-ac57-c374f7634db5.jpg) \ No newline at end of file +## Connect GitHub Enterprise + +If your repository is on GitHub Enterprise Cloud (`*.ghe.com`) or GitHub Enterprise Server, select **GitHub Enterprise** instead of **GitHub**, and fill in **GitHub Enterprise API URL**: + +- GitHub Enterprise Cloud with data residency: `https://api..ghe.com`; +- GitHub Enterprise Server: `https://github..com/api/v3`. + +The other fields are the same as for GitHub: **GitHub Username**, **API Token** (created in your GitHub Enterprise), and **Organization/Repository**. diff --git a/src/content/docs/integrations/issues-management/images/github/0-connect-github-steps.png b/src/content/docs/integrations/issues-management/images/github/0-connect-github-steps.png new file mode 100644 index 00000000..e2cd62cd Binary files /dev/null and b/src/content/docs/integrations/issues-management/images/github/0-connect-github-steps.png differ diff --git a/src/content/docs/integrations/issues-management/images/github/1-connect-github.png b/src/content/docs/integrations/issues-management/images/github/1-connect-github.png new file mode 100644 index 00000000..afcf15a3 Binary files /dev/null and b/src/content/docs/integrations/issues-management/images/github/1-connect-github.png differ diff --git a/src/content/docs/integrations/issues-management/images/linear/4-connect-to-ims.png b/src/content/docs/integrations/issues-management/images/linear/4-connect-to-ims.png index 17b6a932..be08e2b3 100644 Binary files a/src/content/docs/integrations/issues-management/images/linear/4-connect-to-ims.png and b/src/content/docs/integrations/issues-management/images/linear/4-connect-to-ims.png differ diff --git a/src/content/docs/integrations/issues-management/linear.md b/src/content/docs/integrations/issues-management/linear.md index f256961f..71d1a7c5 100644 --- a/src/content/docs/integrations/issues-management/linear.md +++ b/src/content/docs/integrations/issues-management/linear.md @@ -26,12 +26,10 @@ Testomat.io connects to Linear with a personal API key. Linear calls it an **API ![The Create API key form in Linear with Key name, Permissions, and Team access](./images/linear/2-linear-create-api-key.png) -6. Click the copy icon next to the key. +6. Click the copy icon next to the key. Copy the key before you leave the page - Linear shows it only once. ![The new Linear API key with the copy icon](./images/linear/3-linear-copy-api-key.png) -Copy the key before you leave the page - Linear shows it only once. - ## Connect Linear ![The Issues management page in Settings with the Connect to IMS button](./images/linear/4-connect-to-ims.png)