🐛🧑‍💻 - Error merging release branch after successful deployment

[efraespada]

Is there an existing issue for this?

• I have searched the existing issues.

Which actions are affected?

Pull Request

Which platforms are affected?

No response

Description

The release branch was merged on master but not on develop. At the end, we had an error in the procedure steps:

Issue #ANY_ISSUE_NUM was not closed because one or more merge operations failed.

No PRs had any problem with getting merged (all checks passed), and there were no conflicts between head/base branches.

Reproducing the issue

Create a release and add the deploy label. It will happen after a successful deployment.

copilot Version

master

Relevant Log Output

Additional context and comments

No response

[vypbot]

🐛 Bugfix Actions

1. The issue was assigned to @efraespada (creator).
2. The issue's title was updated from Error merging release branch after successful deployment to 🐛🧑‍💻 - Error merging release branch after successful deployment.
3. The issue was linked to vypdev and moved to the column Todo.
4. Priority set to P0 in vypdev.
5. The branch develop was used to create bugfix/314-error-merging-release-branch-after-successful-deployment.
6. Moved issue to In Progress in vypdev.

Reminder

1. Take a coffee break while you work ☕.
2. Check out the branch:

git fetch -v && git checkout bugfix/314-error-merging-release-branch-after-successful-deployment

3. Commit the needed changes with this prefix:

bugfix-314-error-merging-release-branch-after-successful-deployment

4. Open a Pull Request from bugfix/314-error-merging-release-branch-after-successful-deployment to develop. New PR

🚀 Happy coding!

[vypbot]

🐛 Bugfix Actions

1. Recommended steps (OpenCode Plan agent):
2. Based on my analysis of the codebase, here's my understanding of the issue and recommended steps to address it:

Issue Summary

The release branch merges successfully to master but fails to merge to develop, causing the error: "Issue #ANY_ISSUE_NUM was not closed because one or more merge operations failed."

Root Cause: In deployed_action_use_case.ts:75-96, two sequential merge operations are performed. While the first succeeds, the second can fail due to merge conflicts, branch protection differences, or develop having diverged since the release branch was created. The current implementation doesn't provide specific error details to help diagnose which merge failed or why.

---

Recommended Implementation Steps

1. Setup & Analysis

1.1. Review Current Error Handling

• Examine src/data/repository/merge_repository.ts:159-212 to understand how merge errors are captured
• Check what error information is available from GitHub API responses
• Note: Errors are logged via logError() but not included in returned Result objects

1.2. Identify Specific Error Scenarios
Common causes for the develop merge failing while master succeeds:

• Merge conflicts between release branch and develop
• Different branch protection rules on develop vs master
• Develop branch diverged with new commits not in release
• Required status checks on develop that don't exist on master

2. Implementation

2.1. Enhance Error Reporting in Merge Operations
Modify src/data/repository/merge_repository.ts to include specific error details in the Result object:

// In the catch block (around line 186-211), include error details:
result.push(
    new Result({
        id: 'branch_repository',
        success: false,
        executed: true,
        steps: [
            `Failed to merge branch \`${head}\` into \`${base}\`.`,
            `Error: ${error instanceof Error ? error.message : String(error)}`,
        ],
        error: error,
    })
);

2.2. Improve Deployed Action Error Messages
Update src/usecase/actions/deployed_action_use_case.ts:147-160 to provide clearer guidance:

// Enhance the failure message to indicate which merge failed:
if (mergesAttempted) {
    const failedMerges = mergeResults
        .filter(r => !r.success)
        .map(r => r.steps?.join(', ') || 'unknown')
        .join('; ');
    
    result.push(
        new Result({
            id: this.taskId,
            success: false,
            executed: true,
            steps: [
                `Issue #${param.singleAction.issue} was not closed because one or more merge operations failed.`,
                `Failed merges: ${failedMerges}`,
                `Please check for merge conflicts or branch protection rules on \`${param.branches.development}\`.`,
            ],
        })
    );
}

2.3. Add Optional Develop Branch Update (Configuration-Based)
Consider adding a configuration option to update develop before merging:

// In deployed_action_use_case.ts, before merging to develop:
if (param.pullRequest.updateDevelopBeforeMerge) {
    // Optional: Merge master into develop first to ensure it's up-to-date
    await this.branchRepository.mergeBranch(
        param.owner,
        param.repo,
        param.branches.defaultBranch,  // master
        param.branches.development,     // develop
        param.pullRequest.mergeTimeout,
        param.tokens.token,
    );
}

2.4. Add Graceful Degradation for Partial Merges
Consider allowing the issue to close if the master merge succeeds but develop fails, with a warning:

// Option: Make develop merge failure non-blocking
const masterMergeSucceeded = mergeResults[0]?.success;
const developMergeSucceeded = mergeResults[1]?.success;

if (masterMergeSucceeded) {
    await this.issueRepository.closeIssue(...);
    if (!developMergeSucceeded) {
        result.push({
            success: true, // or false with warning
            steps: ['Issue closed, but develop merge failed. Manual merge required.']
        });
    }
}

3. Tests

3.1. Update Existing Tests
Modify src/usecase/actions/__tests__/deployed_action_use_case.test.ts:

• Add test case verifying error details are included when merge fails
• Test that specific error messages from merge operations are propagated

3.2. Add New Test Cases

it('includes specific error details when merge fails', async () => {
    mockMergeBranch
        .mockResolvedValueOnce(successResult('Merged into main'))
        .mockResolvedValueOnce([
            new Result({
                id: 'branch_repository',
                success: false,
                executed: true,
                steps: ['Failed to merge', 'Error: Merge conflict detected'],
                error: new Error('Merge conflict'),
            })
        ]);
    // Test that error details are included in final result
});

3.3. Run Test Suite

npm test
npm run test:coverage

4. Documentation

4.1. Update Troubleshooting Documentation
Document common causes for develop merge failures and solutions:

• How to resolve merge conflicts manually
• Checking branch protection rules
• Understanding the merge order (master first, then develop)

4.2. Update Configuration Documentation
If adding new configuration options (like updateDevelopBeforeMerge), document them in:

• action.yml
• Project documentation (docs.page)

5. Verification

5.1. Build and Lint

npm run build
npm run lint

5.2. Test in Staging

• Create a test release branch
• Introduce a divergence in develop that would cause a merge conflict
• Verify the improved error message appears
• Confirm the issue remains open with clear instructions

---

Key Files to Modify

File	Purpose
src/data/repository/merge_repository.ts	Include error details in failed merge results
src/usecase/actions/deployed_action_use_case.ts	Better error reporting and optional graceful degradation
src/usecase/actions/__tests__/deployed_action_use_case.test.ts	Updated tests for new error handling

Would you like me to proceed with implementing these changes, or would you prefer to focus on a specific approach (e.g., just improving error messages vs. adding the develop update option)?

Reminder

1. Take a coffee break while you work ☕.

🚀 Happy coding!

[vypbot]

🐛 Bugfix News

Changes on branch bugfix/314-error-merging-release-branch-after-successful-deployment:

---

• e752467 by Efra Espada (@efraespada)

Enhance documentation and implementation for deploy label and merge flow. Added new sections in README and index.mdx, and improved MergeRepository to wait for PR-specific check runs before merging. Updated tests for MergeRepository and DeployedActionUseCase to cover new behavior and ensure correctness in handling merges and check waits.

---

• 3959fd1 by Efra Espada (@efraespada)

Enhance MergeRepository and DeployedActionUseCase documentation to clarify PR-specific check run handling and deployment flow. Updated comments and type definitions to reflect new behavior, ensuring better understanding of the merging process and check wait logic.

---