CI: Allow PRs against feature and hotfix branches

[AlexSkrypnyk]

Our current CI GHA setup:

name: Database, Build, Test and Deploy

on:
  push:
    # Pushes to the following branches will trigger the workflow.
    branches:
      - production
      - main
      - master
      - develop
      - release/**
      - hotfix/**
      - project/**
    # Pushes of tags will also trigger the workflow.
    tags:
      - '*'
  # Pull requests to the following branches will trigger the workflow.
  pull_request:
    types:
      - opened
      - synchronize
      - reopened
    branches:
      - production
      - main
      - master
      - develop
      - release/**
      - hotfix/**
      - project/**

Need to allow feature/** and bugfix/**.

Same for CircleCI.

Then need to review and update docs under .vortex/docs

[AlexSkrypnyk]

@coderabbitai plan this

[coderabbitai]

Coding Plan

Summary

• Add feature/** and bugfix/** glob patterns to both push.branches and pull_request.branches in the main GitHub Actions workflow file
• CircleCI requires no changes as it already supports these branch patterns through its existing regex configuration
• Update the GitHub Actions documentation to reflect the complete branch configuration and correct the incomplete example snippet

Design Choices

Design Choice 1: CircleCI configuration does not require changes

Options Considered:

1. Modify CircleCI config to explicitly add feature/bugfix branch patterns
2. Leave CircleCI unchanged since it already supports these branches

Chosen Option: 2

Rationale: The existing configuration already allows feature/bugfix branches to trigger all CI jobs, so changes would be redundant. The exploration revealed that CircleCI already supports feature/** and bugfix/** branches. The database, lint, and build jobs have no branch filters (they run on all branches), and the deploy job's regex already includes ^(feature|bugfix)\/[a-zA-Z0-9\-\.\,_]+$. No modifications are needed.

Design Choice 2: Vortex internal test workflows are out of scope

Options Considered:

1. Update all three GitHub Actions workflow files for consistency
2. Update only build-test-deploy.yml as specified in the ticket

Chosen Option: 2

Rationale: The ticket explicitly targets the main CI workflow; internal Vortex workflows can be updated separately if needed. The vortex-test-common.yml and vortex-test-installer.yml workflows are Vortex-internal maintenance workflows, not the main project CI. The ticket specifically references "Our current CI GHA setup" pointing to build-test-deploy.yml.

💡 User Tips

Regenerate the plan with different choices with @coderabbitai <feedback>.

Implementation Steps

Phase 1: Update GitHub Actions CI Workflow

Add feature/** and bugfix/** branch patterns to the main CI workflow to enable pipeline execution for these branch types on both push events and pull requests.

Task 1: Add Branch Patterns to Push Trigger

Add the missing branch patterns to enable CI runs when code is pushed directly to feature or bugfix branches.

• Update .github/workflows/build-test-deploy.yml in the on.push.branches section
• Add feature/** pattern to match all feature branches (e.g., feature/login, feature/123-new-ui)
• Add bugfix/** pattern to match all bugfix branches (e.g., bugfix/fix-auth, bugfix/456-crash)
• Place new entries after hotfix/** to maintain logical grouping with other development branch patterns

Task 2: Add Branch Patterns to Pull Request Trigger

Add the same branch patterns to the pull_request trigger to enable CI runs when PRs target feature or bugfix branches.

• Update .github/workflows/build-test-deploy.yml in the on.pull_request.branches section
• Add feature/** and bugfix/** patterns matching the push trigger configuration
• This enables CI validation for PRs targeting these branches (e.g., a sub-feature PR into a parent feature branch)

🤖 Prompt for AI agents

Update the main GitHub Actions CI workflow file to add `feature/**` and
`bugfix/**` branch patterns to both push and pull_request triggers.

- In `.github/workflows/build-test-deploy.yml`, locate the `on.push.branches`
section and add `feature/**` and `bugfix/**` entries after `hotfix/**` to
maintain logical grouping
- In the same file, locate the `on.pull_request.branches` section and add the
same `feature/**` and `bugfix/**` patterns, mirroring the push trigger
configuration
- These glob patterns should match branches like `feature/login`,
`feature/123-new-ui`, `bugfix/fix-auth`, and `bugfix/456-crash`

Phase 2: Update Documentation

Ensure documentation accurately reflects the updated branch trigger configuration.

Task 1: Update GitHub Actions Documentation

Correct the incomplete branch list in the GitHub Actions setup documentation.

• Update .vortex/docs/content/continuous-integration/github-actions.mdx in the "Update deployment branches" section
• Expand the example on.push.branches list to include: production, main, master, develop, release/**, hotfix/**, feature/**, bugfix/**, project/**
• Add a corresponding on.pull_request.branches section showing the same branch patterns
• The current snippet is truncated and missing several branch patterns including bugfix/**

Task 2: Verify CI Overview Documentation

Confirm the general CI documentation already reflects the correct trigger conditions.

• Review .vortex/docs/content/continuous-integration/README.mdx in the "Trigger conditions" section
• The exploration confirmed this file already lists feature/* and bugfix/* correctly
• No changes expected; this task is for verification only to ensure consistency across docs

🤖 Prompt for AI agents

Update the GitHub Actions documentation to reflect the complete and correct
branch trigger configuration, and verify the CI overview documentation is
already consistent.

- In `.vortex/docs/content/continuous-integration/github-actions.mdx`, find the
"Update deployment branches" section and expand the example `on.push.branches`
list to include all branches: `production`, `main`, `master`, `develop`,
`release/**`, `hotfix/**`, `feature/**`, `bugfix/**`, `project/**`
- In the same file, add a corresponding `on.pull_request.branches` section
showing the same complete set of branch patterns
- Review `.vortex/docs/content/continuous-integration/README.mdx` in the
"Trigger conditions" section to confirm it already lists `feature/*` and
`bugfix/*` correctly — no edits are expected, this is verification only

Research

The project uses both GitHub Actions and CircleCI for continuous integration. The primary CI workflow is .github/workflows/build-test-deploy.yml, which defines push and pull_request triggers with explicit branch allowlists. The CircleCI configuration in .circleci/config.yml uses regex-based branch filters at the job level. Documentation lives under .vortex/docs/content/continuous-integration/ with separate files for the general CI overview (README.mdx), GitHub Actions specifics (github-actions.mdx), and CircleCI specifics (circleci.mdx).

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

Update the main GitHub Actions CI workflow file to add `feature/**` and
`bugfix/**` branch patterns to both push and pull_request triggers.

- In `.github/workflows/build-test-deploy.yml`, locate the `on.push.branches`
section and add `feature/**` and `bugfix/**` entries after `hotfix/**` to
maintain logical grouping
- In the same file, locate the `on.pull_request.branches` section and add the
same `feature/**` and `bugfix/**` patterns, mirroring the push trigger
configuration
- These glob patterns should match branches like `feature/login`,
`feature/123-new-ui`, `bugfix/fix-auth`, and `bugfix/456-crash`
===============================================================================

Task: 2

Update the GitHub Actions documentation to reflect the complete and correct
branch trigger configuration, and verify the CI overview documentation is
already consistent.

- In `.vortex/docs/content/continuous-integration/github-actions.mdx`, find the
"Update deployment branches" section and expand the example `on.push.branches`
list to include all branches: `production`, `main`, `master`, `develop`,
`release/**`, `hotfix/**`, `feature/**`, `bugfix/**`, `project/**`
- In the same file, add a corresponding `on.pull_request.branches` section
showing the same complete set of branch patterns
- Review `.vortex/docs/content/continuous-integration/README.mdx` in the
"Trigger conditions" section to confirm it already lists `feature/*` and
`bugfix/*` correctly — no edits are expected, this is verification only

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- `@coderabbitai` You can skip phase 3. Add a simple unit test case for phase 2.
- `@coderabbitai` For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!