feat: update GitHub Actions Workflow for Merge Conflict #269
Conversation
mhmohona
requested review from
derberg,
alequetzalli,
fmvilas,
KhudaDad414 and
asyncapi-bot-eve
as code owners
| **Options to Resolve Conflicts:** | ||
| - **Manually:** Resolve the conflicts in your local environment and push the changes. | ||
| - **Automated Commands:** Use `/rebase`, `/solve_conflict`, or `/sf` to automatically rebase this PR. | ||
| **Good Practices:** |
There was a problem hiding this comment.
you mean good practice for manual resolution?
There was a problem hiding this comment.
Tried to cover this part -
Bonus:
Maybe some tips on what is the best way to solve the merge conflict 🤔 good and bad practices.
|
@mhmohona do you plan to continue with this one? |
|
I will, please give me some time. |
|
@mhmohona do you plan to continue with this one or should we ask community to continue? |
| fi | ||
| - name: Set Output | ||
| id: set_output | ||
| run: echo "::set-output name=conflicts::${{ env.conflicts }}" |
There was a problem hiding this comment.
this way is a long time deprecated method for exposing data from step
also, what is the point of this step if in the previous one you already properly expose conflicts variable?
example from other workflows -> https://github.com/asyncapi/.github/blob/master/.github/workflows/if-nodejs-pr-testing.yml#L35
| - Consider using a visual diff tool to clearly see and resolve conflicts. | ||
| - Test your changes after resolving to ensure nothing is broken. | ||
| For more detailed guidance, refer to your project's contributing guidelines or documentation. | ||
| auto-rebase: |
There was a problem hiding this comment.
is the indentation proper? should't it be a new job instead of part of message?
did you test the workflow somewhere?
| uses: actions/github-script@v6 | ||
| with: | ||
| script: | | ||
| await github.rest.issues.createComment({ |
There was a problem hiding this comment.
why one time you use marocchino/sticky-pull-request-comment and another manually add comment using GH API?
Description
This PR updates the GitHub Actions workflow to handle merge conflicts and provide auto-rebase functionality.
Here is the workflow shown in below diagram -
flowchart TD A[Start: PR Created or Updated] -->|Check for Conflicts| B{Merge Conflicts?} B -- Yes --> C[Post Merge Conflict Notification] B -- No --> D[End: No Action Required] C --> E[Wait for User Action] E -->|User comments `/rebase`, `/solve_conflict`, or `/sf`| F[Perform Automatic Rebase] F -- Success --> G[Post Success Message and Clean Up Comments] F -- Failure --> H[Post Failure Message] G --> I[End: Rebase Successful] H --> J[End: Rebase Failed, Manual Resolution Required]Related issue(s) #181