首页
/ Gem Release 项目技术文档

Gem Release 项目技术文档

2024-12-20 03:24:52作者:冯爽妲Honey

1. 安装指南

安装步骤

要安装 gem-release,只需在终端中运行以下命令:

gem install gem-release

安装完成后,gem-release 将作为 RubyGems 的插件,提供一系列自动化命令来简化 gem 开发流程。

2. 项目的使用说明

主要功能

gem-release 插件旨在通过自动化基于约定、配置和模板的重复性工作,简化 gem 开发流程。它为 RubyGems 的 gem 命令添加了以下命令:

  • bootstrap:从模板文件中搭建一个新的 gem。
  • gemspec:生成 gemspec 文件。
  • bump:更新一个或多个 gem 的版本号。
  • tag:为当前版本的 gem 打标签。
  • release:发布一个或多个 gem。

使用示例

以下是一些常见的使用场景:

  • 搭建新 gem

    gem bootstrap my_gem
    
  • 更新 gem 版本

    gem bump my_gem --version minor
    
  • 发布 gem

    gem release my_gem
    

3. 项目API使用文档

命令详解

gem bootstrap

功能:从模板文件中搭建一个新的 gem。

参数

  • gem_name:gem 的名称(可选,默认使用当前目录名称)。

选项

  • --[no-]scaffold:是否搭建 gem 文件(默认:true)。
  • --dir DIR:放置 gem 的目录(默认:给定的名称或当前工作目录)。
  • --bin:创建可执行文件 ./bin/[name],并在 .gemspec 中添加 executables 指令。
  • --template NAME:用于搭建的模板组。
  • --rspec:使用 rspec 组(默认添加 .rspecspec/spec_helper.rb)。
  • --travis:使用 travis 组(默认添加 .travis.yml)。
  • --[no-]license NAME:添加的许可证(默认:mit)。
  • --strategy NAME:收集文件的策略 [glob|git](默认:glob)。
  • --[no-]git:初始化 git 仓库(默认:true)。
  • --github:初始化 git 仓库并在 GitHub 上创建。
  • --remote:git 远程仓库。
  • --push:将 git 仓库推送到 GitHub。

gem bump

功能:更新一个或多个 gem 的版本号。

参数

  • gem_name:gem 的名称(可选,默认使用目录名称或所有 gemspec 文件)。

选项

  • --version VERSION:目标版本(如 next majorx.x.x)。
  • --[no-]commit:更新版本后创建提交(默认:true)。
  • --message MESSAGE:提交消息模板(默认:Bump %{name} to %{version} %{skip_ci})。
  • --skip-ci:在提交消息中添加 [skip ci] 标签。
  • --push:将新提交推送到 git 远程仓库。
  • --remote REMOTE:推送的 git 远程仓库(默认:origin)。
  • --sign:GPG 签名提交消息。
  • --branch [BRANCH]:为目标版本创建新分支。
  • --tag:运行 gem tag 命令的快捷方式。
  • --release:运行 gem release 命令的快捷方式。
  • --recurse:递归到包含 gemspec 文件的目录。
  • --file FILE:版本文件的完整路径。

gem gemspec

功能:生成 gemspec 文件。

参数

  • gem_name:gem 的名称(可选,默认使用当前目录名称)。

选项

  • --[no]-bin:在 gemspec 中添加 bin 文件指令(默认:如果存在 ./bin 目录则为 true)。
  • --dir DIR:放置 gem 的目录(默认:给定的名称或当前工作目录)。

4. 项目安装方式

安装命令

gem install gem-release

配置文件

gem-release 支持通过配置文件或环境变量来设置默认选项。配置文件可以位于以下位置之一:

  • ~/.gem_release/config.yml
  • ~/.gem_release.yml
  • ./.gem_release/config.yml
  • ./.gem_release.yml

配置文件必须使用 YAML 格式,并按命令列出选项。例如:

quiet: true

release:
  host: https://example.com

环境变量也可以用于设置默认选项,例如:

GEM_RELEASE_PRETEND=true

配置文件和环境变量中的默认选项可以在命令行中被覆盖。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511