- - {project-name}-pypi-release-verify-{stream}
- - gerrit-pypi-release-verify
- - github-pypi-release-verify
-
-:Required Parameters:
-
- :build-node: The node to run build on, which must be Centos.
- :jenkins-ssh-credential: Credential to use for SSH. (Generally set
- in defaults.yaml)
-
-:Optional Parameters:
-
- :branch: The branch to build against. (default: master)
- :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
- :build-timeout: Timeout in minutes before aborting build. (default: 15)
- :disable-job: Whether to disable the job (default: false)
- :dist-binary: Whether to build a binary wheel distribution. (default: true)
- :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
- :parallel: Boolean indicator for tox to run tests in parallel or series.
- (default: false, in series)
- :pre-build-script: Shell script to execute before the tox builder.
- For example, install prerequisites or move files to the repo root.
- (default: a string with a shell comment)
- :pypi-repo: Key for PyPI repository parameters in the .pypirc file.
- Release jobs should use a server like pypy.org. (default: pypi)
- :python-version: Python version to invoke pip install of tox-pyenv
- (default: python3)
- :stream: Keyword representing a release code-name.
- Often the same as the branch. (default: master)
- :submodule-recursive: Whether to checkout submodules recursively.
- (default: true)
- :submodule-timeout: Timeout (in minutes) for checkout operation.
- (default: 10)
- :submodule-disable: Disable submodule checkout operation.
- (default: false)
- :tox-dir: Directory containing the project's tox.ini relative to
- the workspace. The default uses tox.ini at the project root.
- (default: '.')
- :tox-envs: Tox environments to run. If blank run everything described
- in tox.ini. (default: '')
- :use-release-file: Whether to use the release file. (default: true)
-
-PyPI Release Merge
-------------------
-
-Publishes a Python library on merge of a patch set with a release yaml
-file. Runs tox, builds source and (optionally) binary distributions,
-checks the format of the version string, checks that the distribution
-file names contain the release version string, checks that no tag
-exists in the code repository for the release version, tags the code
-repository with the release version, pushes the tag to the git server,
-and uploads distributions to a PyPI repository.
-
-This job is similar to the PyPI merge job, but is only triggered by
-merge of a release yaml file and checks the version and tag before
-uploading to a public repository such as PyPI.
-
-See the PyPI Release Verify job above for documentation of the release
-yaml file format.
-
-The build node for PyPI release merge jobs must be CentOS, which
-supports the sigul client for accessing a signing server.
-
-A Jenkins user can also trigger this release job via the "Build with
-parameters" action, removing the need to merge a release yaml file.
-The user must enter parameters in the same way as a release yaml file,
-except for the special USE_RELEASE_FILE and DRY_RUN check boxes. The
-user must uncheck the USE_RELEASE_FILE check box if the job should run
-with a release file, while passing the required information as build
-parameters. Similarly, the user must uncheck the DRY_RUN check box to
-test the job while skipping upload of files to a repository.
-
-The special parameters are as follows::
-
- VERSION = 1.0.0
- USE_RELEASE_FILE = false
- DRY_RUN = false
-
-:Template Names: