diff --git a/astro.config.mjs b/astro.config.mjs index dab5881f..6581df61 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -90,6 +90,7 @@ export default defineConfig({ { label: 'Playwright', link: '/tutorials/playwright'}, { label: 'Java Integration', link: '/tutorials/java'}, { label: 'WebdriverIO', link: '/tutorials/webdriver'}, + { label: 'Working With Plans', link: '/tutorials/working-with-plans'}, ], }, { diff --git a/src/content/docs/tutorials/Working-with-Plans.md b/src/content/docs/tutorials/Working-with-Plans.md new file mode 100644 index 00000000..fd3fc6dd --- /dev/null +++ b/src/content/docs/tutorials/Working-with-Plans.md @@ -0,0 +1,68 @@ +--- +title: Working with Plans +description: Learn how to work with test plans in Testomat.io. This guide walks you through creating a plan, choosing its type — manual, automated, or mixed — selecting tests with collections and filters, keeping the plan in sync automatically with tags and suites, running it, and reviewing the results. +type: article +url: https://docs.testomat.io/tutorials/working-with-plans +head: + - tag: meta + attrs: + name: og:image + content: https://docs.testomat.io/_astro/New_b1BS3EKN_2024-08-29.DGrFkMLR_ZOOgn1.webp + + - tag: meta + attrs: + name: keywords + content: test plans, Testomat.io, test management, manual test plan, automated test plan, mixed test plan, plan collections, filters, dynamic test selection, tags, labels, suites, test run, CI/CD, test reports, QA +--- + +Welcome! + +A test plan is a saved set of tests you can run again and again without picking them each time. It's great for the runs you repeat, like a regression pass before every release or a weekly smoke check. + +![Plan and runs chart](./images/working-with-plans/plan-to-runs.png) + +What you will do: + +1. Create a plan. +2. Add tests to it. +3. Launch a run from the plan. + +## Create a plan +1. Open the **Plans** tab in the sidebar. +2. Click **+ New** in the top right corner. +3. Choose the plan type. Select **Manual** to run tests manually. (Automated and Mixed plans also exist, for tests run through CI.) +4. Give the plan a clear name, like "Release regression." + +![The Plans page with the + New plan button and the type choice](./images/working-with-plans/1-create-new-run.png) + +## Add tests to the plan + +Now choose which tests belong in this plan. + +1. Pick tests from the tree by selecting folders and suites, or use a filter to grab tests by tag or priority. +2. Save the plan. + +![Selecting tests for the plan from the test tree](./images/working-with-plans/2-select-tests-from-tree.png) + +Your plan is now saved and ready to reuse. The next time you need this same set, you won't have to pick the tests again. + +## Launch a run from the plan + +1. Open your plan and start a manual run from it. +2. Work through the run, marking each test Passed, Failed, or Skipped, then click Finish Run. + +![Launching a run from a saved plan](./images/working-with-plans/3-launch-a-run-from-plan.png) + +For the full run walkthrough, see [Run Manual Tests](https://docs.testomat.io/getting-started/#run-manual-tests). + +:::note + +For [Automated](https://docs.testomat.io/getting-started/#run-automated-tests) or [Mixed](https://docs.testomat.io/project/runs/running-manual-and-automated-tests/#how-to-launch-mixed-runs) plans, the Launch button only works once [Continuous Integration](https://docs.testomat.io/integrations/continuous-integration/#_top) is set up. Manual plans have no such requirement. + +::: + +## Next steps + +* Run your plan whenever you need it in [Run Manual Tests](https://docs.testomat.io/getting-started/#run-manual-tests) and [Run Automated Tests](https://docs.testomat.io/getting-started/#run-automated-tests). +* Prepare a plan run to start later with [Scheduled Runs](https://docs.testomat.io/project/runs/managing-runs/#scheduled-runs). +* Keep plans tidy with labels, see [Tags & Labels](https://docs.testomat.io/project/runs/managing-runs/#tags-and-labels-on-manual-run-page). \ No newline at end of file diff --git a/src/content/docs/tutorials/images/working-with-plans/1-create-new-run.png b/src/content/docs/tutorials/images/working-with-plans/1-create-new-run.png new file mode 100644 index 00000000..9e570326 Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-plans/1-create-new-run.png differ diff --git a/src/content/docs/tutorials/images/working-with-plans/2-select-tests-from-tree.png b/src/content/docs/tutorials/images/working-with-plans/2-select-tests-from-tree.png new file mode 100644 index 00000000..2968d275 Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-plans/2-select-tests-from-tree.png differ diff --git a/src/content/docs/tutorials/images/working-with-plans/3-launch-a-run-from-plan.png b/src/content/docs/tutorials/images/working-with-plans/3-launch-a-run-from-plan.png new file mode 100644 index 00000000..74c68785 Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-plans/3-launch-a-run-from-plan.png differ diff --git a/src/content/docs/tutorials/images/working-with-plans/plan-to-runs.png b/src/content/docs/tutorials/images/working-with-plans/plan-to-runs.png new file mode 100644 index 00000000..4bc59c1d Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-plans/plan-to-runs.png differ