ci: add testRigor Web E2E suite

[amandassa-tR]

Feature Preview

Adds a testRigor plain-English E2E suite for AppFlowy Web, plus a GitHub Actions workflow to run it from CI.

Covered flows (under testRigor/):

• Document create / edit / delete / restore / publish
• Rich text blocks & slash menu
• Grid sort & filter
• Board (Kanban) cards, groups, and fields
• Favorites & sub-pages
• Global Search / Quick-find
• Invite new user and accept workspace invite
• Sign up / create workspace / delete account
• Shared reusable rules (login, sign up, delete account, etc.)

Description

This introduces tests-as-code for AppFlowy Web using testRigor so contributors and maintainers can keep E2E coverage next to the product code.

The workflow installs testrigor-cli and runs the suite with --explicit-mutations, so the files in testRigor/testcases and testRigor/rules are the source of truth for what executes.

CI setup required on the repo (or fork) that runs the workflow:

• Secret TESTRIGOR_API_KEY (PAT from testRigor → username → API Tokens); optional fallback TESTRIGOR_AUTH_TOKEN
• Variable TESTRIGOR_TEST_SUITE_ID
• Optional variable APPFLOWY_WEB_URL (defaults to https://appflowy.com/app)

Triggers: workflow_dispatch, and push to non-main branches when testRigor/** or the workflow file change.

---

PR Checklist

• My code adheres to AppFlowy's Conventions (commit messages use type: subject)
• I've listed at least one issue that this PR fixes in the description above.
• I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
• All existing tests are passing.

Test plan

• Confirm required secrets/vars are set on the fork/org that should run CI
• Run workflow via workflow_dispatch (or push a change under testRigor/)
• Verify the suite finishes green and the JUnit artifact uploads
• Spot-check a couple of cases locally with testrigor test-suite run against the suite ID

Summary by Sourcery

Introduce testRigor Web E2E coverage and automate its execution through GitHub Actions.

New Features:

• Add comprehensive testRigor Web E2E coverage for document lifecycle, rich text, grids, boards, favorites, search, invitations, and account/workspace flows.

Enhancements:

• Add shared testRigor rules, suite structure, settings, and test data for maintainable tests-as-code coverage.

CI:

• Add a GitHub Actions workflow to run the testRigor suite on demand or when E2E definitions change, with configurable credentials, suite ID, application URL, and JUnit artifact reporting.

Tests:

• Add reusable testRigor test cases covering core AppFlowy Web user journeys.

[sourcery-ai]

Reviewer's Guide

Adds a testRigor tests-as-code suite for major AppFlowy Web user journeys, shared reusable rules, and a GitHub Actions workflow that runs the explicitly synchronized suite on configured non-main changes or manual dispatch, with JUnit artifact reporting.

Sequence diagram for synchronized testRigor suite execution

sequenceDiagram
    actor Contributor
    participant GitHub as GitHub Actions
    participant Runner as Ubuntu Runner
    participant CLI as testRigor CLI
    participant TestRigor as testRigor Service
    participant App as AppFlowy Web
    participant Artifacts as JUnit Artifact Storage

    Contributor->>GitHub: Push testRigor/workflow change or dispatch workflow
    GitHub->>Runner: Checkout repository and setup Node.js
    Runner->>CLI: Install testrigor-cli
    Runner->>CLI: testrigor test-suite run
    CLI->>TestRigor: Sync explicit testcases and rules
    TestRigor->>App: Execute E2E user journeys
    App-->>TestRigor: Test results
    TestRigor-->>CLI: Exit status and JUnit report
    CLI-->>Runner: Complete synchronous run
    Runner->>Artifacts: Upload report.xml

Loading

File-Level Changes

Change	Details	Files
Adds a CI workflow that synchronizes and runs the local testRigor suite against AppFlowy Web.	Installs the testRigor CLI on Node.js 20. Validates API credentials and suite configuration, including an auth-token fallback and configurable application URL. Runs in synchronous mode with explicit local test-case/rule mutations and commit metadata. Uploads the generated JUnit report even when the test job fails. Scopes automatic execution to non-main pushes affecting the suite or workflow, with manual dispatch and concurrency cancellation.	.github/workflows/testrigor.yml
Introduces the testRigor project structure and shared reusable rules for common account and document operations.	Defines paths for test cases, rules, test data, and datasets. Adds reusable login, sign-up, account deletion, document deletion, and custom input-entry rules.	testRigor/structure.yaml testRigor/rules/Delete account.txt testRigor/rules/Delete current document.txt testRigor/rules/Login using password.txt testRigor/rules/Sign up using password.txt testRigor/rules/custom enter \"value\" into \"input\".txt
Adds plain-English E2E coverage for core AppFlowy Web document, editor, database, navigation, search, collaboration, and account flows.	Covers document lifecycle actions including create, edit, delete, restore, and publish. Exercises rich-text blocks, slash-menu interactions, grid sorting/filtering, and comprehensive Kanban operations. Validates favorites, sub-pages, global search, and quick-find behavior. Covers workspace invitations from both inviter and invitee perspectives. Tests sign-up, workspace creation, and account deletion.	testRigor/testcases/Board_(Kanban)_—_full_regression__cards,_groups,_hidden_groups,_fields.txt testRigor/testcases/Document_Create,_Edit,_Delete,_Restore_and_Publish.txt testRigor/testcases/Favorites_and_Sub-pages_(E2E).txt testRigor/testcases/Global_Search___Quick-find_(E2E).txt testRigor/testcases/Grid_Row__Sort_and_Filter_Operations.txt testRigor/testcases/Invite_new_user_to_the_workspace.txt testRigor/testcases/Invitee_accepts_workspace_invite_(E2E).txt testRigor/testcases/Rich_Text_Blocks_and_Slash_Menu_(E2E).txt testRigor/testcases/Sign_up,_create_a_new_workspace_and_delete_account.txt
Updates repository ignore rules to exclude generated testRigor run output.	Prevents local test artifacts from being committed.	.gitignore

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[sourcery-ai]

Hey - I've found 1 issue

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path=".github/workflows/testrigor.yml" line_range="84-90" />
<code_context>
+
+          # Sync mode (no --async): exit code gates the job.
+          # --explicit-mutations: local testRigor/testcases (+ rules) is authoritative —
+          # only those cases are kept/updated on the suite and executed. Remote-only
+          # cases not present as files are dropped from the suite.
+          testrigor test-suite run "${TESTRIGOR_TEST_SUITE_ID}" \
+            --url "${APP_URL}" \
+            --test-cases-path "testRigor/testcases/**/*.{txt,yaml,yml}" \
+            --rules-path "testRigor/rules/**/*.{txt,yaml,yml}" \
+            --explicit-mutations \
+            --branch "${GITHUB_REF_NAME}" \
+            --commit "${GITHUB_SHA}" \
</code_context>
<issue_to_address>
**issue (bug_risk):** Concurrent runs from different feature branches use the same `TESTRIGOR_TEST_SUITE_ID` while each run treats its checked-out test cases and rules as authoritative, so one branch overwrites or removes the other branch's suite definitions and the runs execute a nondeterministic mixture of files.

**Triggers:** When multiple feature branches push changes while their workflows are running concurrently.

**Suggested fix:** Use an isolated testRigor suite per branch, or serialize mutations to the shared suite and separate synchronization from execution.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue (bug_risk): Concurrent runs from different feature branches use the same TESTRIGOR_TEST_SUITE_ID while each run treats its checked-out test cases and rules as authoritative, so one branch overwrites or removes the other branch's suite definitions and the runs execute a nondeterministic mixture of files.

Triggers: When multiple feature branches push changes while their workflows are running concurrently.

Suggested fix: Use an isolated testRigor suite per branch, or serialize mutations to the shared suite and separate synchronization from execution.