Skip to content

Conversation

@mahlau-flex
Copy link
Contributor

@mahlau-flex mahlau-flex commented Oct 7, 2025

Made a small change to the github workflow such that the jobs are triggered if a PR is edited (for example the title). This makes it easier to change the title to conform to the new linting rules.

Greptile Overview

Updated On: 2025-10-07 12:44:33 UTC

Summary

This PR makes a minimal but purposeful change to the GitHub Actions workflow configuration to improve developer experience when working with PR title requirements. The change adds 'edited' to the list of pull request event types that trigger the `tidy3d-python-client-tests.yml` workflow.

The workflow includes a 'lint-branch-name' job that enforces Jira key requirements by checking both branch names and PR titles as a fallback mechanism. Prior to this change, if a developer created a PR with a branch name lacking a Jira key, they would need to either create a new branch or close and reopen the PR to trigger the workflow validation after updating the PR title. Now, developers can simply edit their PR title to include the required Jira key, and the workflow will automatically re-run to validate compliance.

This change integrates seamlessly with the existing workflow infrastructure, maintaining all current functionality while reducing friction for developers who need to comply with the repository's commit linting rules. The modification aligns with the codebase's emphasis on developer productivity and automated quality checks.

Important Files Changed

Changed Files
Filename Score Overview
.github/workflows/tidy3d-python-client-tests.yml 5/5 Added 'edited' to pull request event triggers to enable workflow re-runs when PR titles are modified

Confidence score: 5/5

  • This PR is safe to merge with minimal risk as it only adds a standard GitHub Actions trigger type
  • Score reflects the simplicity of the change and its alignment with established workflow patterns
  • No files require special attention as this is a straightforward configuration change

Sequence Diagram

sequenceDiagram
    participant User
    participant GitHub
    participant WorkflowEngine as "Workflow Engine"
    participant DetermineScope as "determine-test-scope"
    participant Lint as "lint"
    participant BranchLint as "lint-branch-name"
    participant CommitLint as "lint-commit-messages"
    participant SchemaVerify as "verify-schema-change"
    participant LocalTests as "local-tests"
    participant RemoteTests as "remote-tests"
    participant PRRequirements as "pr-requirements-pass"

    User->>GitHub: "Edit PR (title/description)"
    GitHub->>WorkflowEngine: "Trigger workflow on 'edited' event"
    WorkflowEngine->>DetermineScope: "Start determine-test-scope job"
    
    DetermineScope->>GitHub: "Check PR approval status"
    GitHub-->>DetermineScope: "Return approval state"
    DetermineScope->>DetermineScope: "Determine local_tests and remote_tests flags"
    DetermineScope-->>WorkflowEngine: "Output test scope decisions"

    par Parallel execution
        WorkflowEngine->>Lint: "Start linting (if tests enabled)"
        Lint->>Lint: "Run ruff format and check"
        Lint-->>WorkflowEngine: "Linting results"
    and
        WorkflowEngine->>BranchLint: "Start branch name linting"
        BranchLint->>BranchLint: "Check branch name and PR title for Jira key"
        BranchLint-->>WorkflowEngine: "Branch lint results"
    and
        WorkflowEngine->>CommitLint: "Start commit message linting"
        CommitLint->>CommitLint: "Check commit message format"
        CommitLint-->>WorkflowEngine: "Commit lint results"
    and
        WorkflowEngine->>SchemaVerify: "Start schema verification"
        SchemaVerify->>SchemaVerify: "Regenerate and verify schemas"
        SchemaVerify-->>WorkflowEngine: "Schema verification results"
    and
        WorkflowEngine->>LocalTests: "Start local tests (if enabled)"
        LocalTests->>LocalTests: "Run test suite with coverage"
        LocalTests-->>WorkflowEngine: "Local test results"
    and
        WorkflowEngine->>RemoteTests: "Start remote tests (if approved)"
        RemoteTests->>RemoteTests: "Run tests on multiple platforms"
        RemoteTests-->>WorkflowEngine: "Remote test results"
    end

    WorkflowEngine->>PRRequirements: "Start requirements check"
    PRRequirements->>PRRequirements: "Validate all required jobs passed"
    PRRequirements-->>GitHub: "Final workflow status"
    GitHub-->>User: "Workflow completion notification"
Loading

Context used:

Rule from dashboard - When implementing Jira key enforcement for pull requests, provide a fallback to check the PR title i... (source)

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

@github-actions
Copy link
Contributor

github-actions bot commented Oct 7, 2025

Diff Coverage

Diff: origin/develop...HEAD, staged and unstaged changes

No lines with coverage information in this diff.

@yaugenst-flex yaugenst-flex added this pull request to the merge queue Oct 7, 2025
Merged via the queue into develop with commit 7b3c66d Oct 7, 2025
79 of 81 checks passed
@yaugenst-flex yaugenst-flex deleted the chore/workflow-trigger-on-pr-edit branch October 7, 2025 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants