我想知道是否可以在 GitLab CI 运行程序中更改存储在 GitLab 中的 Python 包版本。
我有示例包结构：
/package
/src
/__init__.py
main.py
setup.py
Dockerfile
.gitlab-ci.yml
__init__.py __version__ = '1.0.0'
setup.py setup(
name='foo',
version=src.__version__,
packages=find_packages(),
install_required=[foo, bar]
)
用于碰撞和发布的简单工作流程如下所示：在 github 和 pypi 上发布新的 python 包版本的最佳工作流程和实践
但是我们可以在
__init__.py我喜欢为此使用凹凸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
我的项目根目录中还有一个
.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
使用了两个自定义变量。需要将它们添加到存储库设置中的 CI 变量中。如果您想在不受保护的分支上使用它们，请确保取消选中受保护的检查。
MY_PUSH_TOKENPYPI_TOKEN最后但并非最不重要的一点，值得一提的是：
上面的示例使用了一个位于组中的存储库，如果您有一个不在组内的存储库，您可能需要更改 set-url 原始地址。
-o ci.skip用途：
ci 工作负责打包、发布、上传和碰撞到下一个补丁。
要更改主要或次要功能，请在功能分支中本地从命令行手动调用它并推送它。
bump2version 工具也会自动处理标记。
我用来获得此解决方案的一些资源：
一个选项是使用 setuptools_scm（来自 Python Packaging Authority）。为了确定版本
setuptools_scm如果您有自动标记版本的机制，上述方法效果最佳，但您可以选择手动添加标记。无论如何，您想要的是
setuptools_scm2.1.12下面的示例说明了典型设置的样子。我使用
semantic-delivery-gitlabmaster配置
setuptools_scm:# pyproject.toml
[build-system]
requires = ["setuptools>=45", "wheel", "setuptools_scm>=6.2"]
[tool.setuptools_scm]
write_to = "my_library/__version__.py"
获取版本：
# `my_library/__init__.py`
try:
from my_library.__version__ import version as __version__
except ImportError:
pass
最小
.gitlab-ci.yaml# .gitlab-ci.yaml
stages:
- build
- release
- publish
build:
stage: build
script:
- pip install --upgrade pip
- pip install setuptools setuptools_scm[toml] --upgrade
- python setup.py bdist_wheel
artifacts:
expire_in: 7 days
paths:
- dist/*
.publish:
stage: publish
script:
- WHEEL=$(ls dist)
- publish_artifact.sh # Upload wheel to repository manager (e.g. artifactory)
publish-snapshot:
<<: *publish
except:
- tags
- master
publish-release:
<<: *publish
only:
- tags
release:
stage: release
script:
- npx @hutson/semantic-delivery-gitlab --token ${GITLAB_AUTH_TOKEN}
only:
- master
when: manual # Manually trigger the tagging job for better control
您可能还想将
my_library/__version__.py.gitignore>>> import my_library
>>> my_library.__version__
1.0.1