Skip to content

feat: 更新文档 #217 #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# devops-release-gradle-plugin

## 功能介绍
`devops-release-gradle-plugin`是一个用于自动化发布的一个插件,帮助我们管理项目版本,简化发布流程,自动
完成以下内容:
`devops-release-gradle-plugin`是一个用于自动化发布的一个插件,帮助我们管理项目版本,简化发布流程,自动完成以下内容:

- 检查是否有未提交的内容
- 去掉-SNAPSHOT,生成发布版本号
Expand Down Expand Up @@ -39,8 +38,9 @@ gradle release

## 配置插件

默认是根据version.txt文件,自动生成发布版本,并根据SemVer,增加MINOR,生成下一个开发版本,标签则是在发布版本
前增加v。可以使用gradle preview,预览发布插件自动生成的信息。
默认是根据version.txt文件,自动生成发布版本,并根据SemVer,增加MINOR,生成下一个开发版本,标签则是在发布版本前增加v。

可以使用gradle generateReleaseProperties,预览发布插件自动生成的信息。

所以我们只需添加如下配置:

Expand Down
6 changes: 3 additions & 3 deletions docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ devops-framework/
### 分支管理
项目采用主干开发模式,主要包含以下几种分支:

* master 主干开发分支
* release-* 已发布的版本分支
* ... 其他特性分支,如jdk17
* `master` 主干开发分支
* `release-*` 已发布的版本分支
* `...` 其他特性分支,如jdk17

## How to publish to maven repository?

Expand Down
Loading