开源项目 `versioning` 使用教程

开源项目 versioning 使用教程

versioningGradle plug-in to generate version information from the SCM branch (Git or Svn)项目地址:https://gitcode.com/gh_mirrors/ve/versioning

1. 项目的目录结构及介绍

versioning/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── nemerosa/
│   │   │           └── versioning/
│   │   │               ├── AbstractInfoDecorator.java
│   │   │               ├── InfoDecorator.java
│   │   │               ├── InfoService.java
│   │   │               ├── Version.java
│   │   │               ├── VersionComputer.java
│   │   │               ├── VersioningExtension.java
│   │   │               ├── VersioningPlugin.java
│   │   │               ├── VersioningProperty.java
│   │   │               ├── VersioningService.java
│   │   │               └── git/
│   │   │                   ├── GitBranchInfoDecorator.java
│   │   │                   ├── GitCommitInfoDecorator.java
│   │   │                   ├── GitVersionComputer.java
│   │   │                   └── GitVersioningService.java
│   │   └── resources/
│   │       └── META-INF/
│   │           └── services/
│   │               └── com.nemerosa.versioning.VersioningService
│   └── test/
│       ├── java/
│       │   └── com/
│       │       └── nemerosa/
│       │           └── versioning/
│       │               ├── AbstractInfoDecoratorTest.java
│       │               ├── GitVersionComputerTest.java
│       │               ├── GitVersioningServiceTest.java
│       │               ├── VersionComputerTest.java
│       │               └── VersioningServiceTest.java
│       └── resources/
│           └── logback-test.xml
├── .gitignore
├── LICENSE
├── README.md
├── pom.xml

目录结构介绍

• src/main/java/com/nemerosa/versioning/: 包含项目的主要源代码文件。
  • AbstractInfoDecorator.java: 抽象信息装饰器类。
  • InfoDecorator.java: 信息装饰器接口。
  • InfoService.java: 信息服务类。
  • Version.java: 版本类。
  • VersionComputer.java: 版本计算器类。
  • VersioningExtension.java: 版本控制扩展类。
  • VersioningPlugin.java: 版本控制插件类。
  • VersioningProperty.java: 版本控制属性类。
  • VersioningService.java: 版本控制服务接口。
  • git/: 包含与Git相关的版本控制服务实现。
    • GitBranchInfoDecorator.java: Git分支信息装饰器类。
    • GitCommitInfoDecorator.java: Git提交信息装饰器类。
    • GitVersionComputer.java: Git版本计算器类。
    • GitVersioningService.java: Git版本控制服务实现类。
• src/main/resources/META-INF/services/: 包含服务提供者配置文件。
  • com.nemerosa.versioning.VersioningService: 版本控制服务配置文件。
• src/test/java/com/nemerosa/versioning/: 包含项目的测试代码文件。
  • AbstractInfoDecoratorTest.java: 抽象信息装饰器测试类。
  • GitVersionComputerTest.java: Git版本计算器测试类。
  • GitVersioningServiceTest.java: Git版本控制服务测试类。
  • VersionComputerTest.java: 版本计算器测试类。
  • VersioningServiceTest.java: 版本控制服务测试类。
• src/test/resources/: 包含测试资源文件。
  • logback-test.xml: 测试日志配置文件。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• pom.xml: Maven项目配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 VersioningPlugin.java，它是一个插件类，负责初始化和配置版本控制服务。

package com.nemerosa.versioning;

import org.pf4j.Plugin;
import org.pf4j.PluginWrapper;

public class Version

versioningGradle plug-in to generate version information from the SCM branch (Git or Svn)项目地址:https://gitcode.com/gh_mirrors/ve/versioning