Clever Geek Handbook

Mavenを使用したセマンティックバージョン管理の自動化（SemVer GitFlow Maven）

バージョン制御にセマンティックアプローチを使用していますか？gitflowを使用していますか？あなたはおそらく、バージョンの調整、ブランチの作成、マスター/開発からのマージ、バージョンの再調整、マージの競合の処理などのプロセスに精通しているでしょう。



この記事では、ライブラリに基本的に使用するリリースプロセスと、それを自動化する方法について簡単に説明します。通常、ビルド番号を使用するCI / CDアプローチを使用しますが、ライブラリではセマンティックバージョン管理を使用することを選択しました。いくつかの会社でこれに伴う面倒なリリースプロセスに遭遇し、ついに解決策を見つけました。



この記事はMavenに関するものですが、Gradleに代わるものもたくさんあります。



サンプルプロジェクトは、GitHubページにあります。



セマンティックバージョン管理とGit



セマンティックバージョン管理は、リリースの分類システムです。1.6.4、1.7.10、1.12.2などのバージョン番号を見たことがあると思います。これらの番号は、MAJOR.MINOR.PATCH（MAJOR.MINOR.PATCH）を表します。



さらに、同じように見えるSNAPSHOTのバージョンがありますが、1.14.4-SNAPSHOTなど、最後に「-SNAPSHOT」が追加されています。



一般的なリリースプロセスは、次の手順で構成されています。



  1. 開発ブランチ（以下、開発ブランチ）からリリースブランチを作成します。
  2. リリースブランチで、すべてのpom.xmlファイルのバージョンをSNAPSHOT（1.2.3-SNAPSHOT）から非SNAPSHOT（1.2.3）に変更します。
  3. 開発ブランチ（1.2.4-SNAPSHOT）でSNAPSHOTバージョンをアップグレードします。
  4. リリースのためにすべてが完了したら、リリースブランチをマスターブランチにマージします。これは現在のリリースです。
  5. マスターブランチまたはリリースブランチを開発ブランチにマージします。


/ , : , , .



, , . , merge .



?



  • , .
  • master SNAPSHOT.
  • CI, .
  • merge .
  • hotfixes ( master ).


gitflow-maven



, maven, pom.xml. . , .



, , . , . , : gitflow-maven-plugin.



, :



  • .
  • release .
  • hotfix.
  • (Merging) .


, . , CI/CD, , .



, (goals) maven. , .



:



, .



$ mvn gitflow:release-start -B


release (-B Batch Mode)



$ mvn gitflow:release


. master .



, , .



$ mvn gitflow:hotfix-start -B


$ mvn gitflow:hotfix-finish -B -DhotfixVersion=1.8.9b


hotfix master , 1.8.9b . . - , .





, poms:



<build>
    <plugins>
        <plugin>
            <groupId>com.amashchenko.maven.plugin</groupId>
            <artifactId>gitflow-maven-plugin</artifactId>
            <version>1.13.0</version>
            <configuration>
                <!-- optional configuration -->
            </configuration>
        </plugin>
    </plugins>
</build>


GitHub maven central.



GitHub. :



<configuration>
    <!-- We use maven wrapper in all our projects instead of a local maven installation -->
    <mvnExecutable>./mvnw</mvnExecutable>

    <!-- Don’t push to the git remote. Very useful for testing locally -->
    <pushRemote>true</pushRemote>

    <!-- Set to true to immediately bump the development version when creating a release branch -->
    <commitDevelopmentVersionAtStart>false</commitDevelopmentVersionAtStart>

    <!-- Which digit to increas in major.minor.patch versioning, the values being 0.1.2 respectively.
         By default the rightmost number is increased.
         Pass in the number via parameter or profile to allow configuration,
         since everything set in the file can't be overwritten via command line -->
    <versionDigitToIncrement>${gitflowDigitToIncrement}</versionDigitToIncrement>

    <!-- Execute mvn verify before release -->
    <preReleaseGoals>verify</preReleaseGoals>
    <preHotfixGoals>verify</preHotfixGoals>

    <!-- Configure branches -->
    <gitFlowConfig>
        <productionBranch>master</productionBranch>
        <!-- default is develop, but we use development -->
        <developmentBranch>development</developmentBranch>
    </gitFlowConfig>
</configuration>


, , . , Gitlab CI.



Gitlab CI



CI/CD Gitlab CI , commit snapshot, merge master — release.



, — , master merge , hotfixes.



Gitlab CI, . :





release. , release, release, snapshot, (merge) master snapshot. - .



git Gitlab CI



git Gitlab CI, : , CI git.



write_repository. , , .



GITLAB_TOKEN, protected, development, release/* hotfix/* (protected). , .



git remote runner, CI . , Gitlab, :



$ git remote set-url --push origin "https://oauth2:${GITLAB_TOKEN}@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git"


git . Git «», git. , git , . :



$ git config user.name "Gitlab CI"
$ git config user.email gitlab-ci@viesure.io


git, CI. .





, git CI, gitflow. .



, , :



· MINOR



· PATCH hotfixes



.



(goals) -B, , .



Release



$ ./mvnw gitflow: release -B -DgitflowDigitToIncrement = $RELEASE_DIGIT


. master SNAPSHOT , . (goal ) maven , .





$ ./mvnw gitflow: release-start -B -DgitflowDigitToIncrement = $RELEASE_DIGIT


$ git push origin HEAD


. , , , (, , ). , , .



$ git symbolic-ref refs/heads/$CI_COMMIT_REF_NAME refs/remotes/origin/$CI_COMMIT_REF_NAME
$ ./mvnw gitflow:release-finish -B -DgitflowDigitToIncrement=$RELEASE_DIGIT


release . Git ( ref) HEAD . Gitlab CI . HEAD . , , HEAD.



master , .



(Hotfix)



, , , , .



$ ./mvnw gitflow:hotfix-start -B -DgitflowDigitToIncrement=$HOTFIX_DIGIT
$ git push origin HEAD


Hotfix-start hotfix, .



$ export CURRENT_VERSION=${CI_COMMIT_REF_NAME/hotfix\/}
$ git symbolic-ref refs/heads/$CI_COMMIT_REF_NAME refs/remotes/origin/$CI_COMMIT_REF_NAME
$ ./mvnw gitflow:hotfix-finish -B -DgitflowDigitToIncrement=$HOTFIX_DIGIT -DhotfixVersion=$CURRENT_VERSION


Hotfix-finish master . : . , , . .



, hotfix-start , . , .



. , .





. , - !



, git CI runners . , , .



, . CI .



Gitlab CI GitHub.







More articles:


All Articles