Pull Requests

A pull request is a proposal to merge a set of changes from one branch into another. In a pull request, collaborators can review and discuss the proposed set of changes before they integrate the changes into the main branch.

In Cloud CMS a pull request occurs when the user merges a branch with another branch:

  • Branch merge: pull from branch
  • Finalize Release: merges from a branch to the Master Branch
  • Finish an Editorial Flow: merging your branch changes to the Master Branch

Default settings

By default, the pull requests are transparent to the user and with all the magic occurring automatically and no manually intervention is required. The setting is on the branch configuration: go to the branch -> click the cog next to the branch name in the header -> Configure

pr1.png

Incoming Pull Requests

Automatically, Pull and Merge any incoming Pull Requests: by default this is checked, ie, No User action needed.

Automatic Conflict Resolution

When merge conflicts occur you can set the rule for how the conflict is handled

pr2.png

Block Direct Commits

This Branch will operate in Read-Only mode. All changes to the Branch will need to be approved and committed via an Editorial Flow or a Release

User management of Pull Requests

If your process requires more control and approval of content pulled into the Master branch then you will need to uncheck 'Automatically, Pull and Merge any incoming Pull Requests'. This will provide full control of each pull request to the appropriate individual.

For example, now when a user 'Finishes' an Editorial Task with an immediate Complete (publish now) a pull request is created. Content is not merged or published un the pull request is approved.

To view the Pull Request listing go to the Project Content view (Green Globe) and then select Pull Requests in the left nav.

pr3.png

This listing shows an Editorial Flow that has finished and is schedule immediately. Clicking on the Pull Request will open the Pull Request details:

pr4.png

Validate Pull Request

You can Validate the pull request from the Validate button in the header. This will highlight any conflicts which must be resolved before the pull request can be merged.

pr5.png

Merge Pull Request

You can Merge the pull request from the Merge button in the header. This will attempt to merge the Editorial Flow into Master.

pr6.png

When Merged, the Pull Request is closed and the Pull Detail page updated

pr7.png

The closed pull request is no longer in the Pull Request listing since it requires no further attention.

pr8.png

Summary

The Task is Complete:

  • The content editor made their required changes in the Editorial Flow
  • The Editorial Flow was 'Finished' (either scheduled for now or the future)
  • The Pull Request was reviewed and merged (perhaps merge conflicts needed to be resolved)
  • Updated Content is merged into Master and published to the target