X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-python-jobs.rst;h=13047edf5c30ab531e6f2bfc2323a26f2b95c2c2;hb=0727a30524c2f708f81448c03dd37d1ebb272167;hp=bea44fc43b8f078e421a65b28ada5c72f646cdcd;hpb=200c13dbad2552db1ba9cfc185b0dc40db863930;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst index bea44fc4..13047edf 100644 --- a/docs/jjb/lf-python-jobs.rst +++ b/docs/jjb/lf-python-jobs.rst @@ -43,7 +43,7 @@ Jenkins server must have a configuration file ".pypirc". :Required Parameters: :pypi-repo: PyPI repository key in .pypirc configuration file; - e.g., "staging" or "pypi". + e.g., "pypi-test" or "pypi". lf-infra-tox-install -------------------- @@ -363,6 +363,7 @@ pyenv variables before running. :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. @@ -395,7 +396,7 @@ PyPI Merge Creates and uploads distribution files on merge of a patch set. Runs tox, builds a source distribution and (optionally) a binary distribution, and uploads the distribution(s) to a PyPI repository. -This job should be configured to use a staging PyPI repository like +This job should be configured to use a test PyPI repository like testpypi.python.org, not a public release area like the global PyPI repository. Like the verify job, this requires a setup.py file for packaging the component. @@ -411,25 +412,23 @@ pyenv variables before running. export PATH="$PYENV_ROOT/bin:$PATH" -Requires a .pypirc configuration file in the Jenkins builder home -directory, an example appears next. +Requires a .pypirc configuration file in the Jenkins builder home directory, +an example appears next that uses API tokens. No repository is needed in the +PyPI section. .. code-block:: bash [distutils] # this tells distutils what package indexes you can push to - index-servers = - staging - pypi + index-servers = pypi-test pypi - [staging] - repository: https://testpypi.python.org/pypi - username: your_username - password: your_password + [pypi-test] + repository: https://test.pypi.org/legacy/ + username: __token__ + password: pypi-test-api-token-goes-here [pypi] - repository: https://pypi.python.org/pypi - username: your_username - password: your_password + username: __token__ + password: pypi-api-token-goes-here :Template Names: @@ -451,6 +450,10 @@ directory, an example appears next. :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) + :cron: Cron schedule when to trigger the job. Supports daily builds. + This parameter also supports multiline input via YAML pipe | character in + cases where one may want to provide more than 1 cron timer. (default: empty) + :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. @@ -458,7 +461,7 @@ directory, an example appears next. :pre-build-script: Shell script to execute before the tox builder. For example, install system prerequisites. (default: a shell comment) :pypi-repo: Key for PyPI repository parameters in the .pypirc file. - Merge jobs should use a server like testpypi.python.org. (default: staging) + Merge jobs should use a server like testpypi.python.org. (default: pypi-test) :python-version: Python version to invoke pip install of tox-pyenv (default: python3) :stream: Keyword representing a release code-name. @@ -559,6 +562,7 @@ An example of a pypi release file appears below. :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. @@ -584,10 +588,6 @@ An example of a pypi release file appears below. :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) - :gerrit_trigger_file_paths: Override file paths used to filter which file - modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit - PyPI Release Merge ------------------ @@ -642,6 +642,7 @@ The special parameters are as follows:: :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. @@ -667,6 +668,3 @@ The special parameters are as follows:: :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) - :gerrit_trigger_file_paths: Override file paths used to filter which file - modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit