什么是 GitHub?

已完成

本单元将回顾以下学习目标:

  • GitHub Enterprise 平台的简要概述
  • 如何创建存储库
  • 将文件添加到存储库
  • 如何搜索存储库
  • gist 和 wiki 简介

GitHub

在详细探索 GitHub 平台之前,请务必了解其构建方式:Git。

Git 是一种分布式版本控制系统,可让开发人员跟踪更改、协作处理代码以及随时间推移管理修订。 GitHub 通过添加协作工具、自动化功能和用户友好的 Web 界面,在 Git 的基础上构建。 了解 Git 基础知识(如提交、分支和合并)将帮助你更有效地使用 GitHub。

GitHub Platform 的概念图像,从上到下分为若干层:AI、协作、生产力、安全性和缩放。

GitHub 是一个基于云的平台,它的核心使用 Git(一个分布式版本控制系统)。 GitHub 平台简化了项目协作过程,并提供网站、命令行工具,以及可使开发人员和用户一起工作的总体流程。

如前所述,GitHub 提供 AI 支持的开发人员平台,用于生成、缩放和交付安全软件。 让我们剖析 GitHub Enterprise 平台的每个核心支柱:AI、协作、生产力、安全性和规模。

AI

生成 AI 正在极大地转变软件开发。 GitHub Enterprise 平台通过 AI 支持的拉取请求和问题、Copilot 聊天Copilot 代理的工作效率以及提供更快的反馈来提高安全性,从而增强协作

协作

协作是 GitHub 所做的一切的核心。 GitHub 提供的工具可帮助团队高效协作,减少延迟和简化工作流。

存储库、问题、拉取请求和其他工具有助于支持跨角色更快地协作、缩短审批周期并提高交付速度。

工作效率

GitHub Enterprise 平台提供的自动化功能可提高生产力。 借助内置的 CI/CD(持续集成和持续交付)工具直接集成到开发流程中,该平台允许用户自动执行重复任务并加快日常工作。 这样,开发人员就可以更专注于编码和解决问题。

安全性

GitHub 从一开始就在每个阶段将安全性直接集成到开发过程中。 GitHub Enterprise 包括本机第一方功能,如 CodeQL机密扫描Dependabot 和安全 概述 ,以最大程度地降低风险。 代码保持私密性,同时仍受益于集成的安全检查。

GitHub 继续投资于企业级安全性和合规性。 GitHub 受高度监管行业的Microsoft和组织信任,遵循全球合规性标准,使其成为大规模安全开发的可靠选择。

缩放

GitHub 是同类最大的开发人员社区,来自 1 亿多名开发人员、4.2 亿存储库和无数部署的实时数据。 GitHub 不断学习和改进其产品。 其大型用户群对开发人员需要的内容提供了不同的视角,从而推动持续创新来满足这些需求。 同时,GitHub 是一个可扩展的平台,来自世界各地的开源开发人员为 GitHub 提供和增强功能,使 GitHub 与众不同。

这已经转变成一种令人难以置信的规模,是世界上任何其他公司都无法比拟的。 来自此大型开发人员基础的见解可帮助 GitHub 不断改进平台。

从本质上讲,GitHub Enterprise 平台侧重于开发人员体验。 它提供协作工具、自动化和 AI 驱动的功能,支持统一开发人员体验中的生产力、安全性和可伸缩性。

现在让我们了解 GitHub 的主干:存储库。

存储库简介

让我们先回顾一下:

  • 什么是存储库?
  • 如何创建存储库
  • 将文件添加到存储库
  • 如何搜索存储库
  • gist、wiki 和 GitHub 页面简介

什么是存储库?

仓库包含项目的所有文件,并存储每个文件的修订记录。 它是帮助你与其他人协作的重要组成部分之一。 你可以使用存储库来管理工作、跟踪更改、存储修订历史记录以及与其他人协作。 在深入探讨之前,让我们先了解如何创建存储库。

如何创建存储库

您可以在个人帐户或者您有足够权限的任何组织中创建新仓库。

让我们逐步了解如何从 github.com 创建存储库。

  1. 在任何页面的右上角,单击下拉菜单并选择“新建存储库”。

    GitHub.com 右上角加号下拉菜单的屏幕截图,第一个选项是“新建存储库”。

  2. 使用“所有者”下拉菜单选择你想要其拥有存储库的帐户。

    谁应是新存储库所有者的下拉菜单的屏幕截图。

  3. 输入仓库的名称和描述(可选)。

    突出显示存储库名称文本框的图像。

  4. 选择存储库可见性。

    • 公共存储库可供 Internet 上的每个人访问。

    • 专用存储库仅供你、你明确与之共享了访问权限的人员访问;对于组织存储库,只有特定的组织成员才能访问。

  5. 选择“创建存储库”。祝贺你! 你刚刚创建了一个存储库!

如何克隆存储库

通过克隆存储库,可以在计算机上创建存储库的本地副本。 这对于在本地进行更改并将其同步回远程存储库非常有用。

  1. 在 GitHub.com,导航到要克隆的存储库主页。

  2. 在文件列表上方,单击“ 代码 ”按钮。

    包含克隆选项的“代码”按钮下拉菜单的屏幕截图。

  3. 使用 HTTPS、SSH 或 GitHub CLI 选项复制存储库的 URL。

  4. 打开终端并导航到要克隆存储库的目录。

  5. 运行以下命令,替换为 <repository-url> 复制的 URL:

    git clone <repository-url>
    
  6. 克隆过程完成后,导航到存储库文件夹:

    cd <repository-name>
    

祝贺! 现在,你拥有存储库的本地副本。

接下来,让我们回顾一下如何将文件添加到存储库。

如何将文件添加到存储库

GitHub 中的文件可以起到许多作用,但主要用途是存储有关项目的数据和信息。 若要将文件添加到存储库,至少需要 写入 访问权限。

让我们回顾一下如何将文件添加到存储库。

  1. 在 GitHub.com 上,导航到存储库的主页。

  2. 在存储库中,通过选择“创建新文件”链接或“上传现有文件”,浏览到要在其中创建文件的文件夹

  3. 添加后,在文件列表上方选择“添加文件 ᐁ”下拉菜单。 然后选择“创建新文件”

    屏幕截图显示用于将文件添加到新存储库的选项,以红色突出显示,屏幕右侧是“添加文件”按钮。

  4. 在文件名字段中,键入文件的名称和扩展名。 要创建子目录,请键入 / 目录分隔符。

  5. 在“文件内容”文本框中,键入文件的内容

  6. 若要查看新内容,请在文件内容上方选择“预览”

    显示一个 yml 文件的屏幕截图,其中突出显示了左上角的“预览”按钮。

  7. 选择“提交更改”。

  8. 在“提交消息”字段中,键入简短且有意义的提交消息,描述对文件所做的更改。 您可以在提交消息中将提交归于多个作者。

  9. 如果你有多个电子邮件地址与 GitHub.com 上的帐户关联,请选择电子邮件地址下拉菜单。 然后选择要用作 Git 作者电子邮件地址的邮箱。 只有经过验证的电子邮件地址才会出现在此下拉菜单中。 如果你启用了电子邮件地址隐私,则 [用户名]@users.noreply.github.com 是默认的提交内容创作者电子邮件地址

    显示提交更改的屏幕截图,其中包含说明框和用于选择提交作者电子邮件的下拉菜单。

  10. 在“提交消息”字段下方,决定是将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。

    显示根据提交选项创建新分支的屏幕截图,其中包含其下方的新分支的文本框。

  11. 选择“提交更改”或“提议更改”

祝贺你,你刚刚在存储库中创建了一个新文件! 你还创建了一个新分支并提交了内容。

在下一个单元中回顾分支和提交之前,让我们快速回顾一下 gist、wiki 和 GitHub 页面,因为它们与存储库类似。

什么是 Gists?

Gists 是 GitHub 的一项功能,允许用户以轻量且便捷的方式共享代码片段、笔记或其他小段信息。 它们本质上是微型 Git 存储库,这意味着可以像完整存储库一样对它们进行分支、克隆和版本控制。 Gists 对于共享快速解决方案、配置文件或示例尤其有用,无需创建完整的存储库。

Gists 的主要功能:

  1. 公共和秘密 Gists

    • 公共 Gists:每个人都可以看到这些内容,可以通过 GitHub 的搜索功能发现。 它们非常适合共享要提供给更广泛的社区的代码片段或解决方案。
    • 秘密 Gists:这些不可搜索或公开列出,但它们并不完全是私人的。 具有 URL 的任何人都可以访问它们。 它们可用于与有限受众(例如协作者或朋友)共享代码。
  2. 版本控制

    • 跟踪对 gist 所做的每一项更改,使你能够查看编辑历史记录。 这样可以轻松还原到以前的版本,或者查看代码片段随时间推移的演变方式。
  3. 创建分支和克隆

    • 与存储库一样,可以分叉和克隆 gists。 这样,其他人就可以基于你的工作或适应其需求。
  4. 嵌入

    • Gists 可以嵌入到网站或博客中,使其成为在教程或文档中共享代码示例的绝佳工具。
  5. Markdown 支持

    • Gists 支持 Markdown 格式,这意味着你可以在代码旁边包括格式文本、标题、链接甚至图像。 这对于向代码片段添加上下文或说明特别有用。
  6. Collaboration:

    • 虽然 gists 通常用于各个代码片段,但也可以由多个用户共享和协作。 对 gists 进行分叉和注释可实现轻量级协作。

Gists 的用例:

  • 共享快速代码示例或解决方案。
  • 存储配置文件或脚本以供个人使用。
  • 为常用代码模式创建模板。
  • 与他人共享错误日志或调试信息。
  • 在博客、论坛或文档中嵌入代码片段。

[!重要提示]

切勿使用 gists 来存储敏感或机密数据,例如密码、机密或 API 密钥,即使在脚本或配置文件中也是如此。
Gists 不是完全私有的:即使是机密 Gists 也可以由具有链接的任何人访问。 在共享之前,请始终仔细查看内容。

Gists 的限制:

  • Gists 不是完全私人的, 即使标记为机密。 具有 URL 的任何人都可以访问它们,因此不应将其用于敏感信息或机密信息。
  • 它们最适合小型代码片段或单个文件。 对于较大的项目或多文件结构,完整存储库更合适。

若要详细了解如何创建和管理 gists,请参阅本模块的“资源”部分中的 GitHub 文档,或访问 GitHub Gists 文档

分叉和克隆 Gists

可以在帐户中创建其他人 gist 的副本。

  1. 导航到要分叉的 gist。
  2. 选择 gist 页面右上角的 分支

在本地克隆 gist:

git clone https://gist.github.com/your-gist-id.git

若要详细了解 gist,请参阅本模块末尾的“资源”部分中标题为“创建 Gist”的链接文章


什么是 Wiki?

GitHub.com 上的每个存储库都配备了一个用于托管文档的部分,称为 wiki。 您可以使用仓库的 wiki 共享项目的长内容,例如如何使用项目,您是如何设计项目的,或者其核心原则是什么。 虽然自述文件能够快速告知项目的用途,但你可以使用 wiki 来提供其他文档。

值得注意的是,如果你的存储库是私密的,则只有对该存储库至少拥有读取访问权限的人员才能访问你的 wiki。

创建、编辑和删除 Wiki 页面

可以使用 GitHub Wiki 为项目创建和管理文档。

若要创建 Wiki 页面,请执行以下作:

  1. 导航到存储库。
  2. 选择 Wiki 选项卡。
  3. 选择“ 创建第一页 ”(如果不存在页面),或 “新建页面 ”以添加页面。
  4. 输入标题和内容,然后选择“ 保存页面”。

编辑 Wiki 页面:

  1. 导航到要编辑的 Wiki 页面。
  2. 选择右上角的 “编辑 ”。
  3. 进行更改,然后选择“ 保存页”。

若要删除 Wiki 页面,请执行以下作:

  • 删除 Wiki 页面需要使用 Git。 克隆 Wiki 存储库,删除文件并推送更改。

详细了解如何在 GitHub Docs 中管理 Wiki - 添加或编辑 Wiki 页面

什么是功能预览版?

功能预览版允许你在正式发布之前试用 GitHub 上的实验功能。 这些预览版可让你提前访问新功能,并允许你提供反馈来帮助塑造最终产品。

启用或禁用功能预览:

  1. 通过在 GitHub.com 右上角选择个人资料图片,导航到 GitHub 帐户。
  2. 从下拉菜单中选择 功能预览
  3. 浏览可用预览列表并切换要尝试的功能。

功能预览是保持领先曲线并探索可增强 GitHub 体验的新工具的好方法。

小窍门

GitHub 经常为用户添加新的实验性功能来探索,因此请关注 功能评审 ,以发现新的工具和增强功能。