GitLab CI 凹凸 Python 包版本

sor*_*ike 5 python python-3.x gitlab gitlab-ci

我想知道是否可以在 gitlab ci runner 中更改存储在 gitlab 中的 Python 包版本。

我有示例包结构:

/package
  /src
    /__init__.py
     main.py
  setup.py
  Dockerfile
  .gitlab-ci.yml
Run Code Online (Sandbox Code Playgroud)

init.py包括:

  __version__ = '1.0.0'
Run Code Online (Sandbox Code Playgroud)

setup.py 包括:

  setup(
        name='foo',
        version=src.__version__,
        packages=find_packages(),
        install_required=[foo, bar]
  )
Run Code Online (Sandbox Code Playgroud)

碰撞和发布的简单工作流程如下所示:在 github 和 pypi 上发布新的 python 包版本的最佳工作流程和实践

但是我们可以自动在 __init_.py 中修改版本,同时直接在 gitlab-ci 中发布吗?

Pim*_*oek 7

我喜欢为此使用凹凸2版本包。

这是我的 gitlab-ci.yml ,其中包含(几乎)最低限度的设置:

image: python:latest

# Change pip's cache directory to be inside the project directory since we can
# only cache local items.
variables:
  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"

# Pip's cache doesn't store the python packages
# https://pip.pypa.io/en/stable/reference/pip_install/#caching
#
# If you want to also cache the installed packages, you have to install
# them in a virtualenv and cache it as well.
cache:
  paths:
    - .cache/pip
    - venv/

before_script:
  - python --version
  - pip install virtualenv
  - virtualenv venv
  - source venv/bin/activate
  - pip install -r requirements.txt

stages:
  - build
  - release

upload package:
  stage: release
  script:
    - pip install twine bump2version
    - bump2version --tag release
    - python setup.py sdist bdist_wheel
    - TWINE_PASSWORD=${PYPI_TOKEN} TWINE_USERNAME=__token__ python -m twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
    # Necessary to avoid a bug corrupting the version in setup.py. Just in case it's forgotten to do manually. Now we only have to explicitly bump version for major or minors.
    - bump2version patch
    - git config --global user.email "${GITLAB_USER_EMAIL}"
    - git config --global user.name "${GITLAB_USER_NAME}"
    - git remote set-url origin "https://gitlab-ci-token:${MY_PUSH_TOKEN}@gitlab.com/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}.git"
    - git push -o ci.skip --tags origin HEAD:${CI_COMMIT_REF_NAME}
  artifacts:
    paths:
      - dist/*.whl
  only:
    - master
Run Code Online (Sandbox Code Playgroud)

我的项目根目录中还有一个.bumpversion.cfg文件,其中包含以下内容:

[bumpversion]
commit = True
tag = False
current_version = 0.1.0-dev0
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+)(?P<build>\d+))?
serialize = 
    {major}.{minor}.{patch}-{release}{build}
    {major}.{minor}.{patch}

[bumpversion:file:setup.py]

[bumpversion:part:build]

[bumpversion:part:release]
optional_value = gamma
values = 
    dev
    gamma

Run Code Online (Sandbox Code Playgroud)

使用两个自定义变量。需要将它们添加到存储库设置中的 CI 变量中。如果您想在不受保护的分支上使用它们,请确保取消选中受保护的检查。

  • MY_PUSH_TOKEN- 这是在我的个人资料中创建的个人访问令牌。它具有 read_repository 和 write_repository 权限。我是这个存储库的所有者/维护者,因此它授予推送这个存储库的权限。

  • PYPI_TOKEN- 可选,需要将包推送到 pypi.org。

最后但并非最不重要的一点,值得一提的是:

  • 上面的示例使用位于组中的存储库,如果您有一个不在组内的存储库,则可能需要更改 set-url 原始地址。

  • -o ci.skip参数阻止构建管道触发循环

用法:

  • 创建功能分支
  • 推送代码
  • 创建合并请求
  • 合并 MR 到 master

ci 工作负责打包、发布、上传和跳转到下一个补丁。

要更改主要或次要功能,请在功能分支中本地从命令行手动调用它并推送它。

凹凸2版本工具也会自动处理标记。

我用来获得此解决方案的一些资源: