---

工作日常系列文章-论理论知识在大、小公司的价值体现

---

上篇文章 持续交付-目标

• Jenkins官网
• Jenkins下载
• Jenkins博客
• Jenkins文档
• Jenkins插件
• Jenkins社区
• Jenkins-蓝海项目
• Jenkins-issues
• Jenkins-Wiki
• Jenkins行为规范

仓库代码

• CloudBees Github
• Jenkins Github

---

本文描述 Jenkins文档 阅读笔记

---

Guided Tour-入门指导

• 1、Index-首页
  • 1、描述了如何下载和安装Jenkins；
  • 2、描述了Jenkinsfiles 的优势；
  • 3、描述了Pipeline（管道）的优势；
• 2、Create your first Pipeline-创建第一个Pipeline
  • 1、描述如何使用Jenkins创建一个Pipeline项目；
  • 2、描述了Pipeline项目的代码示例；
  • 3、描述了Pipeline的两种表达方式：Declarative Pipeline(声明式管道) 和 Scripted Pipeline(脚本式管道)；
• 3、Runnig multiple steps-运行多step(步骤)的Pipeline
  • 1、描述了具备多个step(步骤)的Pipeline项目示例；
• 4、Defining execution environments-定义执行器的环境
  • 1、描述如何定义一个执行器的环境；
• 5、Using environment variables-使用环境变量
  • 1、描述如何使用环境变量；
• 6、Recording tests and artifacts-记录测试和工件发布
  • 1、简单描述Pipeline如何配置单元测试；
  • 2、简单描述Pipeline如何配置工件包发布；
• 7、Cleaning up and notifications-清空工作空间和通知
  • 1、 描述Pipeline结束后的处理方法：
    • post （声明式管道示例）
    • try catch finally -> currentBuild.result (脚本式管道示例)
  • 2、描述Pipeline删除工作空间方法：deleteDir() （声明式管道示例）
  • 3、描述Pipeline的通知方式：mail
• 8、Deployment-部署
  • 1、描述Pipeline的完整步骤：Build -> Test -> Deploy

---

User Handbook-用户手册

• 1、 Getting Started with Jenkins-开始Jenkins
  • 1、 Installing Jenkins-安装Jenkins
    • 1、 介绍Jenkins的安装方法
• 2、Using Jenkins-使用Jenkins
  • 1、Fingerprints-文件指纹（空）
    • 1、通过该功能可以检验本地下载的文件在Jenkins服务器项目、编译号的归属；
  • 2、Remote API-远程API（空）
• 3、Managing Jenkins-管理Jenkins
  • 1、Configuring the System-配置系统（空）
  • 2、Managing Security-安全管理
    • 1、描述了Jenkins的权限管理、用户管理、项目管理、agent管理等安全方面；
  • 3、Managing Tools-管理工具（空）
    • 1、描述了 Ant、Git、JDK、Maven 等工具；
  • 4、Managing Plugins-管理插件
    • 1、描述了Jenkins几种安装插件的方式：在线安装、本地安装、命令行安装；
  • 5、Jenkins CLI-Jenkins命令行工具
    • 1、描述了Jenkins的命令行工具；
    • 2、描述了Jenkins命令行使用SSH；
    • 3、描述了Jenkins的客户端命令行工具；
  • 6、Script Console-脚本输出（空）
  • 7、Managing Nodes-管理节点（空）
  • 8、Managing Users-管理用户（空）
• 4、Best Practices-最佳实践（空）
• 5、Pipeline-管道

  • 1、描述了Pipeline的定义；

  • 2、描述了Pipeline的流程图；

  • 3、描述了Pipeline的5个优点：代码化、持久性、可暂停、多功能性、可扩展性；

  • 1、Getting Started with Pipeline-开始Pipeline

    • 1、描述了定义Pipeline的两种方式：UI创建方式、Jenkinsfile创建方式；
    • 2、推荐Jenkinsfile创建方式，文件可以在SCM中进行版本管理；
    • 3、介绍了Pipeline语法工具：Snippet Generator
    • 4、描述了全局变量：env、params、currentBuild、docker等常用的全局变量；

  • 2、Using a Jenkinsfile-使用Jenkinsfile

    • 1、Jenkinsfile支持两种语法： Declarative Pipeline(声明式管道) 和 Scripted Pipeline(脚本式管道)
    • 2、描述了一个完整工作流程的示例，Build、Test、Deploy。（声明式管道和脚本式管道示例）
    • 3、描述了一个字符串定义并打印的语法；（注意在Jenkinsfile中 双引号和单引号 的区别）
    • 4、描述了env全局环境变量的使用、修改的语法：声明式管道-environment指令；脚本式管道-withEnv()；
    • 5、描述了设置项目输入参数的语法：声明式管道-parameters指令；脚本式管道-properties()；
    • 6、描述了Job的结束状态语法：声明式管道-post指令；脚本式管道-try/catch/finally & currentBuild.Result；
    • 7、描述了Jenkinsfile使用多个node的语法：声明式管道-agent指令；脚本式管道-node()；
    • 8、描述了step的两种表示语法：short方式 long方式
    • 9、描述了性能优秀的脚本式管道-脚本式管道是 特定领域语言(domain-specific language)，同时以 parallel并行语法举例

  • 3、Branches and Pull Requests-分支和拉取请求

    • 1、描述了 多分支的管道制作方法；

  • 4、Extending with Shared Libraries-待定待定待定待定待定

  • 5、Pipeline Development Tools-管道开发工具

    • 1、描述了三种开发工具
      • Blue Ocean Editor 蓝海项目中的开发工具
      • 命令行检查开发工具
      • Web端的 Replay 功能

  • 6、Pipeline Syntax-管道语法

    • 1、描述了声明式管道、脚本式管道、语法对比三个内容；
    • 2、描述了声明式管道的三个部分：Sections、Directives、Steps
    • 3、描述了声明式管道的Sections及子元素
      • agent：指定运行的节点描述
      • post：描述Job结束时的状态
      • stages：状态描述
      • steps：步骤描述
    • 4、描述了声明式管道的Directives及子元素
      • environment：全局环境变量
      • options：待定
      • parameters：项目执行配置参数
      • triggers：项目触发配置信息
      • stage：配置状态信息
      • tools：配置工具环境信息
      • when：待定
    • 5、描述了声明式管道的Steps及子元素
      • script：配置脚本
    • 6、描述了声明式管道和脚本式管道的差异
      • 声明式管道使用的是 Declarative Programming （声明式编程）
      • 脚本式管道使用的是 Imperative Programming （命令式编程）
      • 声明式管道面向初级使用者；
      • 脚本式管道面向高级使用者；
• 6、Blue Ocean-蓝海项目

  • 描述了Blue Ocean是什么？主要是为了增加Jenkins的用户体验；

  • 传统的UI界面依然保存；

  • Blue Ocean Github

  • Jenkins Design Language

  • 1、Getting Started with Blue Ocean-开始Blue Ocean

    • 描述了 Blue Ocean 插件的安装和使用方法；

  • 2、Creating Pipelines-创建Pipelines

    • 描述了使用Blue Ocean创建Pipeline的步骤；

  • 3、Dashboard-仪表盘

    • 描述了Jenkins仪表盘的功能；

  • 4、Activity View-活动视图

    • 描述了Jenkins活动视图的使用方法；

  • 5、Pipeline Run Details View-Pipeline详细视图

    • 描述了Pipeline的详细视图的使用方法；

  • 6、Pipeline Editor-Pipeline编辑器

• 7、Jenkins Use-Cases-空
  • 1、Jenkins with .NET-空
  • 2、Jenkins with Java-空
  • 3、Jenkins with Python-空
  • 4、Jenkins with Ruby-空
• 8、Operating Jenkins-操作Jenkins
  • 1、Backing-up/Restoring Jenkins-备份/恢复Jenkins（空）
  • 2、Monitoring Jenkins-监测Jenkins（空）
  • 3、Securing Jenkins-Jenkins安全管理
  • 4、Managing Jenkins with Chef-空
  • 5、Managing Jenkins with Puppet-空
• 9、Scaling Jenkins-衡量Jenkins
• 10、Appendix-附录

  • 管理员关注内容

  • 1、Advanced Jenkins Installation-空

• 11、Glossary-词汇表
  • Agent
  • Artifact
  • Build
  • Cloud
  • Core
  • Downstream
  • Executor
  • Fingerprint
  • Folder
  • Item
  • Job
  • Master
  • Node
  • Project
  • Pipeline
  • Plugin
  • Publisher
  • Step
  • Trigger
  • Update Center
  • Upstream
  • Workspace

Resources-资源

• Pipeline Syntax reference-Pipeline Syntax reference介绍

• Pipeline Steps Reference-Pipeline Steps Reference介绍

• LTS Upgrade Guide-Jenkins升级指南

常用文档

• Pipeline Examples-Pipeline示例

• Pipeline Examples Github

• Extending with Shared Libraries-待定待定待定待定待定

• the Workflow global library

• Domain-specific_language

• Groovy-syntax

下篇文章 持续交付-Jenkins博客阅读笔记

---

工作日常系列文章-论理论知识在大、小公司的价值体现

---