如何使用BitBucket代码审查

822 阅读7分钟

代码审查是软件开发过程中的一个核心要素,以确保代码没有错误并达到预期标准。这些审查通常是在将代码合并到主分支之前通过源代码库完成的。Bitbucket是最流行的基于git的源代码库之一,有超过1000万开发者使用它来管理他们的项目。这篇文章将展示如何利用BitBucket的代码审查功能来审查我们的代码。

什么是BitBucket?

BitBucket 是一个 基于git管理的源控制库 服务。它为用户提供了所有必要的功能来处理任何规模的软件开发。作为Atlassian的产品,Bitbucket与所有其他Atlassian服务如JIRA软件、Confluence、Trello、Bamboo和Opsgenie有第一方的集成,以支持整个软件交付过程。

BitBucket的特点

BitBucket服务提供了一整套的功能来满足你所有的代码管理需求,例如。

  • 团队和项目层面的工作流管理。
  • 通过Bitbucket管道的内置持续集成和交付支持。
  • 分支层面的访问控制和管道的部署权限。
  • 代码搜索、代码洞察、代码审查和合并检查功能。
  • 使用JIRA软件的问题跟踪和使用Confluence的Wiki
  • 与第三方服务的整合,包括IDE、安全工具、CI/CD工具等。

BitBucket代码审查功能

代码审查功能 由多种功能组成,以简化整个审查过程。Bitbucket代码审查所采用的代码优先方法强调了拉动请求的单页视图的可读性。它使用户能够快速审查大型代码库,发现问题并轻松地修复它们。任务管理和上下文评论等功能使用户能够轻松管理代码库的变化。将测试结果和安全扫描直接与拉动请求集成,并获得失败的警报,为审查提供了另一层质量控制。

检查构建状态的能力确保没有失败的构建会被合并。开发人员在拉动请求的单页视图所提供的直接导航中完成这项工作。它使用户能够管理整个请求,直到它从单一界面被合并。当使用 高级订阅时,合并条件可以在拉动请求上强制执行,以确保在所有要求得到满足之前,没有任何PR被合并。这些功能使BitBucket代码审查成为功能最丰富而又最主动的代码审查工具之一。

如何用BitBucket审查代码

现在你对我们用Bitbucket代码审查可以实现什么有了一个基本的概念。让我们来看看如何在开发管道中使用这个功能。本节将介绍使用Bitbucket的代码审查过程的主要阶段。

让我们举一个场景的例子。假设你正在开发一个网站,其他开发者为你工作。你想在合并到生产之前审查他们的代码。你可以通过下面描述的一个简单的bitbucket代码管理工作流程来实现这个目的。

如何创建一个资源库

任何软件开发项目的第一步是创建一个资源库来托管和管理源代码。

第1步 - 登录BitBucket,选择顶部菜单上的创建按钮下的版本库选项。

第2步 - 在资源库创建屏幕上提供必要的细节 。

它包括基本信息,如。

  • 项目和版本库名称
  • 版本库的访问级别(它是公共的还是私人的版本库)
  • 默认的分支名称

高级设置,如

  • 仓库描述
  • 分支控制。

提供所有必要的细节,然后点击创建版本库按钮。

注意 - 对于 "Include a README "选项,我们选择了 "Yes, with a tutorial "选项。它将创建一个简单的 README.md 文件,包含一些关于使用版本库的基本说明。

你会被自动激活到新创建的版本库。在这个例子中,web-project 仓库看起来会像下面这样。

第三步 - 现在,我们有了一个全新的版本库。下一步是向这个空的版本库添加一些文件。我们可以通过 CLI、像 Sourcetree这样的 GUI 工具 ,或者 web 界面来完成 。

假设你在本地环境中有下面这个叫做index.html的HTML文件。

<!DOCTYPE html>
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
        <style type="text/css">
        h1 {
            font-family:'Times New Roman', Times, serif;
            font-size: 50px;
            text-align: center;
            color: #0052CC;
            margin-top: 50px;
        }
 
        p {
            font-family:'Times New Roman', Times, serif;
            font-size: 20px;
            text-align: center;
            color: #cc0000;
            margin-top: 50px;
        }
        </style>
        <title>Bitbucket Code Review Test</title>
    </head>
    <body>
        <div width="100%">
            <h1>Test Web Page</h1>
            <hr width="100%" size="5" color="#0052CC">
        </div>
        <div width="50%">
            <p>
                Hello, This is a Simple Web Page
            <p>
                <img src="https://images.unsplash.com/photo-1568144628871-ccbb00fc297c?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80" width="100%"/>
        </div>
    </body>
</html>

我们可以使用 "添加文件 "选项将这段代码添加到版本库中。点击版本库菜单中的添加文件选项。

它将打开源视图,你可以在这里提供文件名和内容。将文件命名为index.html,复制并粘贴内容,然后点击提交。如果需要的话,提供一个提交信息,它将在版本库的选定分支下创建该文件。

一旦文件被创建,你将看到提交的文件。

如何用命令行克隆并在新的分支上进行修改

现在我们有了一个版本库。让我们看看如何在本地开发环境中使用这个 repo。

第1步 - 克隆版本库。点击版本库中的克隆按钮,获得版本库的 URL。

第 2 步 - 使用克隆 URL 并克隆版本库到你的本地环境。下面的例子是基于Windows环境 下的 Powershell的Windows终端

第3步 - 导航到克隆的项目目录,使用git checkout功能创建一个新的分支。

第4步 --在你喜欢的IDE中打开克隆的项目,修改index.html文件。例如,让我们把CSS从head部分移到一个单独的名为main.css的文件。

main.css

h1 {
    font-family:'Times New Roman', Times, serif;
    font-size: 50px;
    text-align: center;
    color: #0052CC;
    margin-top: 50px;
}
 
p {
    font-family:'Times New Roman', Times, serif;
    font-size: 20px;
    text-align: center;
    color: #cc0000;
    margin-top: 50px;
}

index.html

<!DOCTYPE html>
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
        <link rel="stylesheet" href="main.css">
        <title>Bitbucket Code Review Test</title>
    </head>
    <body>
        <div width="100%">
            <h1>Test Web Page</h1>
            <hr width="100%" size="5" color="#0052CC">
        </div>
        <div width="50%">
            <p>
                Hello, This is a Simple Web Page
            <p>
                <img src="https://images.unsplash.com/photo-1568144628871-ccbb00fc297c?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80" width="100%"/>
        </div>
    </body>
</html>

第4步 - 最后,提交修改,用git add、commit和push命令将新的分支推送到Bitbucket。

第5步 - 如果你看一下Bitbucket上的提交部分,你会看到一个新的提交和新的分支。

如何执行拉取请求

现在我们有了一个新的分支,有了变化。下一步是创建拉取请求并进行代码审查。

第 1 步 - 导航到版本库中的拉取请求部分,点击创建拉取请求按钮。

第 2 步 - 输入 PR 的必要细节并创建拉动请求。它将包括要合并的分支,对修改的简短描述,需要审查代码的用户,以及在合并后删除该分支的选项。

3步 - 一旦它创建了PR,用户就可以查看请求并 进行代码审查。请求的页面包含所有请求的细节,包括代码的修改。它还将包括自动化任务,如构建状态、测试和安全扫描细节。

第四步 - 如果代码审查令人满意,下一步就是合并PR。首先,我们需要通过点击 "批准 "按钮来批准该请求。如下图所示,它将把PR的状态改为 "批准"。

第5步 - 通过简单地点击合并按钮来整合PR。它将提示合并屏幕。在这里,提供合并提交和合并策略,然后点击合并,将源分支与主分支连接起来。

第6步 - 通过访问Bitbucket仓库的提交部分来验证合并。在这里,你会看到新的分支已经与主干分支连接了。

总结

代码审查是任何 软件开发方法的一个重要组成部分 。它们提供了一种控制代码质量的方法,并允许开发人员获得同行的反馈以提高他们的技能。任何软件项目都旨在创建一个满足最终用户要求的产品。像 Tabnine这样的人工智能辅助的自动完成工具 可以提高你的团队的生产力。它们将使他们有能力更快、更准确地编写代码,提高软件产品的整体质量。