I
Docs

Get Started

Managing Pull Requests (PRs)

Comprehensive guide to handle Pull Requests (PRs) in Outpost Hub.

Pull requests are crucial for team collaboration, ensuring all code changes are reviewed, approved, and verified before merging into the main branch.

Creating a Pull Request

1
Open your repository and navigate to Pull Requests, then click New Pull Request.
2
Choose the base branch and the branch you wish to merge into it.
3
Adjust the Title and add a Description if needed.
4
Click Create pull request to submit your PR for review. If you wish to save your PR as a draft, click the dropdown next to Create pull request and select Create draft pull request.
You can also initiate a PR by comparing branches. In your repository, go to Branches, locate the branch you want to compare against the base branch, click More options (⋮), and select Compare.

Requesting Reviews

To ask for reviews from other users in your Outpost instance:

1
Go to Pull Requests in your repository and select your PR.
2
On the Conversation tab, find the Reviewers section and click Add.
3
Choose the user you want to assign as a reviewer. Reviewers must be collaborators or organization members. To remove a reviewer, click More options (⋮) next to the reviewer's name and select Remove.
When reviewers leave comments on your PR, you can reply and resolve them on either the Conversation or Changes tabs.

Reviewing and Submitting Feedback

Reviewers can leave feedback, approve, or reject PRs. Anyone with sufficient permissions in the project can review PRs without being assigned as a reviewer.

1
Navigate to Pull Requests in your repository and select the PR you need to review.
2
On the Conversation tab, read the PR description and add comments as needed.
3
On the Changes tab, review the code changes and add line-by-line comments.
Use the + icon to comment on a single line.
Click and drag the + icon to comment on multiple lines.
4
If everything looks good, click Approve to approve the PR for merging.
To request changes, click the dropdown next to Approve and select Request changes.
To leave feedback without making a decision, add comments on the Changes or Conversation tab.
On a PR's Changes tab, you can mark files as Viewed to collapse the diff, which is helpful for reviewing PRs with numerous changed files.
If a file is altered after you mark it as viewed, it will be marked as Change since last viewed, so you don't have to manually check for changes to viewed files.
Outpost also tracks file deletions and additions. If a file is deleted in a PR and you mark it as viewed, and then the file is later restored in the PR, Outpost marks the file accordingly for review in its restored state.

Status Checks

Each pipeline configured in your repository will generate a status check. A failing pipeline will result in a failing status check.

Merging Pull Requests

Outpost automatically detects potential merge conflicts in PRs. If conflicts are found, merging is blocked until they are resolved.

If all checks have passed, choose a merge strategy:

  • Squash and merge: Combines all commits from the source branch into one commit in the base branch.
  • Merge pull request: Adds all commits from the source branch to the base branch via a merge commit.
  • Rebase and merge: Rebases all commits from the source branch and adds them to the base branch.

Squash and merge is the default strategy. To choose another strategy, click the dropdown next to Squash and merge.

Closing Pull Requests

To close a pull request:

1
In your repository, navigate to Pull Requests and select the PR you want to close.
2
Click the dropdown next to Squash and merge and select Close pull request.
3
Click Close pull request again to confirm the closure.
To reopen the PR, select Open for review.