You can now use Embold to review pull requests made on your GitHub or Bitbucket repositories. When a new pull request is made, Embold automatically scans the changed files and reports various issues on Embold UI. Thus Embold facilitates a more effective and easier review of changes in your code.
Setting up pull request workflow
To set up pull request workflow you should:
– Configure webhooks
– Enable pull request workflow for your repositories.
Configuring webhooks
When a new pull request is created via webhooks, GitHub and Bitbucket notify Embold. If the repository credentials (or version control account) configured in Embold has sufficient privileges, Embold will automatically setup webhook on GitHub or Bitbucket.
However, if that is not the case you will have to manually set up the webhook. For manual set up follow the steps given below.
Steps:
- Create a webhook on Github or Bitbucket
- Use Embold webhook receive URL while creating the webhook as target
Note: If your Embold and version control system (such as Bitbucket) is hosted on different networks, you may have to make Embold available to the other network through URL forwarding. Read this guide on URL forwarding for information.
Enabling pull request workflow
You can enable pull request workflow in Embold while linking a repository or later on when you decide to have it. Enabling it during linking a repository is easy. Just select (or check) “Enable pull request” option from link repository pop-up.
You can update this setting or enable pull request at a later point in time from the “Edit repository” pop-up.
Steps:
- Click (…) menu on the top right corner of any repository.
- Select Edit repository.
3. Check or uncheck “Enable pull request” option.
How to use pull request workflow
When a new pull request is created on your GitHub or Bitbucket repository, Embold automatically scans the changed files. Status of this scan can be monitored from GitHub or Bitbucket.
Pull request scan status can also be monitored from the “Development History” page in Embold UI.
Pull request review can be done from the “Development History” page in a repository. This page may not be available if the pull request workflow is disabled. Read the documentation on enabling pull request workflow to know more.
Steps:
- Open “Development History” page from node summary bar.
- Navigate to pull requests tab.
- List of available pull requests can be seen here
- Select a pull request you want to review by clicking it.
- Pull request details pop-up will open.
- Various kinds of issues such as code issues, design issues, etc that are newly created, fixed or carried over can be seen here.
- Use code lane view on the left-hand side to quickly locate issues in a file by clicking them.
- Issues will also be annotated on the margin of code view.
Beta limitations
- On-premise version of Bitbucket and Github is not supported.
- Pull Request workflow is not available for Embold on cloud.
- Forked repositories are not supported.
- Pull Request workflow is available for repositories linked through version control account only (Github/Bitbucket). For more information on version control account refer following:
1. To add a version control account click here.
2. To link a repository through a version control account follow the below steps:
– Go to a corresponding project
– Click on Link repositories
– Select the added version control account from the Repository Type drop down.
– Click on Link Repository button.