数学语义释放

母体项目的自动释放管理

关于

maven- semic-release 是用于 语义释放 v16+. 该项目将部署一个母体项目来母体中心,而不是向npm部署一个节点.js项目. 这个工具意在用于使用Travis-CI服务器的github项目.

工作流程假设您的项目将使用 Angular 式承诺消息 (理论上您可以覆盖此功能并使用不同的样式),只有在您想要创建新版本时才会与主机合并. 生成出一款新出品后,会自动被部署到母体中心.

可选的,您也可以使用这个工具来创建和推动一些承诺,然后将这些承诺重新合并到您 git 仓库的开发分支中 .

设置

这个工具旨在将母体项目的发布自动化到母体中心. 然而,不幸的是,必须采取许多人工步骤来安排你的精良项目,以便它能够正常工作。 感谢Nathan Fischer在博客文章中详细介绍这些步骤 这里。 。 。 .

如果你的项目只是想利用在您的 github 工程上输入版本编号和创建很好的发布注释, 你可以跳过步骤 1-4 。 在第5步中,可以跳过创造出神奇的文物签名密钥 skip-maven-deploy 必须设置旗帜.

步骤1: 与 OSSRH 建立账户

跟随 本指南。 。 。 .

第2步:确保您的 pom.xml 文件准备好发布

样本 pom.xml 的示例项目。 。 。 .

您的 Maven 工程至少需要在 pom.xml 中包含以下项目 :

• name - 项目名称
• description - 一个简短的描述
• url - 用户可以去图书馆了解更多信息的地点
• licences - 不言自明
• scm - 源控制信息
• developers - 在项目上工作的人
• distributionManagement - 你想把项目分发到

插件

您的 pom.xml 文件需要包含以下 maven 插件 :

• maven-gpg-plugin
• maven-javadoc-plugin
• maven-source-plugin

您的 pom.xml 文件还需要以下的sonatype插件来自动关闭并释放您的工程与连接.

• nexus-staging-maven-plugin

样本 pom.xml 的示例项目。 。 。 .

第3步: 创建一个 maven- settings.xml 文件

你可以复制粘贴 此文件 进入您的仓库。 文件必须调用 maven-settings.xml 并必须在您的工程的根目录中存在.

第4步: 创建 gpg 密钥以签名您的文物

跟着所有步骤从 Create code signing cert 改为 Encrypt cert and variables for travis 内 本指南。当向 Travis 添加密钥时,您也可以在您的寄存器的设置中使用 Travis-CI 网站添加密钥,而不是在 .travis.yml 文件中添加安全变量 .

我们祝你好运,因为这一步很容易搞砸,而且完全正确。 将密码添加到travis中可能会令人不快,因为如果它有空间,则可能需要避开其中的一部分,@符号或其他东西.

第5步:创建.travis.yml文件,在成功后运行maven-semantic-release

看这个 示例文件在您的 .travis.yml 文件您想要以下项目 :

成功后( s)

在你的CI Run成功后,您会想用maven-semantic-release插件运行语义放出. 您至少必须包含以下推荐的配置 。 这包括凌驾于插件之上,以免默认的npm插件被使用.

after_success:
  - semantic-release --prepare @conveyal/maven-semantic-release --publish @semantic-release/github,@conveyal/maven-semantic-release --verify-conditions @semantic-release/github,@conveyal/maven-semantic-release --verify-release @conveyal/maven-semantic-release

如果您想要启用传送版本、快照版本以及然后将主机合并到 dev 的 Conveyal 工作流程, 请使用此配置 :

after_success:
  - semantic-release --prepare @conveyal/maven-semantic-release --publish @semantic-release/github,@conveyal/maven-semantic-release --verify-conditions @semantic-release/github,@conveyal/maven-semantic-release --verify-release @conveyal/maven-semantic-release --use-conveyal-workflow --dev-branch=dev

也可以跳过部署到maven Central, 但是仍然通过设置旗来增加版本的pom.xml skip-maven-deploy。例如:

after_success:
  - semantic-release --prepare @conveyal/maven-semantic-release --publish @semantic-release/github,@conveyal/maven-semantic-release --verify-conditions @semantic-release/github,@conveyal/maven-semantic-release --verify-release @conveyal/maven-semantic-release --use-conveyal-workflow --dev-branch=dev --skip-maven-deploy

默认情况下, 承诺信件包含在 pom.xml 被推出时跳过管道运行的附录“ [ci spoot] ” 。 如果需要, 可通过提供旗帜来禁用此选项, 用于快照和最终版本 disable-snapshot-skip-ci 或者说 disable-final-skip-ci。例如:

after_success:
  - semantic-release --prepare @conveyal/maven-semantic-release --publish @semantic-release/github,@conveyal/maven-semantic-release --verify-conditions @semantic-release/github,@conveyal/maven-semantic-release --verify-release @conveyal/maven-semantic-release --use-conveyal-workflow --dev-branch=dev --disable-snapshot-skip-ci --disable-final-skip-ci

如果您只使用更新的传送工作流程 pom.xml 将成为承诺的一部分。 要将更多文件添加到承诺中( 例如由不同插件生成的 CHANGELOG. md) 您可以通过参数指定这些文件 --additionalFilesToCommit。此参数接受文件名列表,并将包含在承诺中。 示例

after_success:
  - semantic-release --prepare @conveyal/maven-semantic-release --publish @semantic-release/github,@conveyal/maven-semantic-release --verify-conditions @semantic-release/github,@conveyal/maven-semantic-release --verify-release @conveyal/maven-semantic-release --use-conveyal-workflow --dev-branch=dev --additionalFilesToCommit CHANGELOG.md,readme.txt

安装前( i)

请确定包含您的签名密钥的导入 。 如果您在第四步中正确跟踪了一切, 您应该在您的. travis. yml 文件中添加如下内容 :

before_install: |
  # only install signing keys under the same circumstances we do a mvn deploy later
  if [[ "$TRAVIS_PULL_REQUEST" = false ]] && [[ "$TRAVIS_BRANCH" = master ]]; then
    openssl aes-256-cbc -K $encrypted_### -iv $encrypted_### -in maven-artifact-signing-key.asc.enc -out maven-artifact-signing-key.asc -d
    gpg --import --batch maven-artifact-signing-key.asc
  fi

缓存 :

这应有助于加速安装出母体语义释放. 您也想要包含 m2 目录 .

cache:
  directories:
    - $HOME/.m2
    - $HOME/.yarn-cache

另外,你也会想在建造前一步安装maven-semantic-release和semantic-release,因为在建造后立即安装travis缓存.

before_script:
  - yarn global add @conveyal/maven-semantic-release semantic-release

第6步:向特拉维斯添加一个" gi"符号

创建 Github 符牌, 用于做出承诺和释放 。 将符号添加到您的 travis 环境变量中 GH_TOKEN 或者说 GITHUB_TOKEN。在您的符号中添加以下权限 :

哪个 mvn 将使用

此插件使用 mvn 命令中 PATH如果您有的话 maven- wrapper 脚本 在工程根目录中,此插件将使用它.