diff --git a/doc/source/contributor/i18n.rst b/doc/source/contributor/i18n.rst index c4efba62f76..845139bbcfe 100644 --- a/doc/source/contributor/i18n.rst +++ b/doc/source/contributor/i18n.rst @@ -21,7 +21,7 @@ level of the text: - _LW() - Used for WARNING level log messages - _LE() - Used for ERROR level log messages (this includes LOG.exception) - _() - Used for any exception messages, including strings used for both - logging and exceptions. + logging and exceptions. .. note:: @@ -49,7 +49,7 @@ to first do the following before any Cinder modules are imported:: from cinder import i18n i18n.enable_lazy() -Note: this should _only_ be called from top level scripts - no library code +Note: this should *only* be called from top level scripts - no library code or common modules should call this method. Any files that use the _() for translation then must have the following diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 8dd082f4e0f..4e8ecc3c551 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -77,7 +77,7 @@ Other Resources launchpad gerrit - jenkins + zuul releasenotes Module Reference diff --git a/doc/source/contributor/jenkins.rst b/doc/source/contributor/jenkins.rst deleted file mode 100644 index cdb04c6ffa3..00000000000 --- a/doc/source/contributor/jenkins.rst +++ /dev/null @@ -1,47 +0,0 @@ -Continuous Integration with Jenkins -=================================== - -Cinder uses a `Jenkins`_ server to automate development tasks. The Jenkins -front-end is at http://jenkins.openstack.org. You must have an -account on `Launchpad`_ to be able to access the OpenStack Jenkins site. - -Jenkins performs tasks such as: - -`gate-cinder-pep8`_ - Run PEP8 checks on proposed code changes that have been reviewed. - -`gate-cinder-pylint`_ - Run Pylint checks on proposed code changes that have been reviewed. - -`gate-cinder-python27`_ - Run unit tests using python2.7 on proposed code changes that have been - reviewed. - -`gate-cinder-python34`_ - Run unit tests using python3.4 on proposed code changes that have been - reviewed. - -`cinder-coverage`_ - Calculate test coverage metrics. - -`cinder-docs`_ - Build this documentation and push it to - `OpenStack Cinder `_. - -`cinder-merge-release-tags`_ - Merge reviewed code into the git repository. - -`cinder-tarball`_ - Do ``python setup.py sdist`` to create a tarball of the cinder code and - upload it to http://tarballs.openstack.org/cinder - -.. _Jenkins: http://jenkins-ci.org -.. _Launchpad: https://launchpad.net -.. _gate-cinder-pep8: https://jenkins.openstack.org/job/gate-cinder-pep8 -.. _gate-cinder-pylint: https://jenkins.openstack.org/job/gate-cinder-pylint -.. _gate-cinder-python27: https://jenkins.openstack.org/job/gate-cinder-python27 -.. _gate-cinder-python34: https://jenkins.openstack.org/job/gate-cinder-python34 -.. _cinder-coverage: https://jenkins.openstack.org/job/cinder-coverage -.. _cinder-docs: https://jenkins.openstack.org/job/cinder-docs -.. _cinder-merge-release-tags: https://jenkins.openstack.org/job/cinder-merge-release-tags -.. _cinder-tarball: https://jenkins.openstack.org/job/cinder-tarball diff --git a/doc/source/contributor/launchpad.rst b/doc/source/contributor/launchpad.rst index 776bb994136..1f8af0e23cf 100644 --- a/doc/source/contributor/launchpad.rst +++ b/doc/source/contributor/launchpad.rst @@ -13,7 +13,7 @@ OpenStack-related sites. These sites include: * `Wiki`_ * Gerrit (see :doc:`gerrit`) - * Jenkins (see :doc:`jenkins`) + * Zuul (see :doc:`zuul`) Mailing list ------------ diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index f6f3beeaead..e1671328e2f 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -17,8 +17,8 @@ modules involved. Mock should be used to remove any external dependencies. All significant code changes should have unit test coverage validating the code happy path and any failure paths. -Any proposed code change will be automatically rejected by the OpenStack -Jenkins server [#f1]_ if the change causes unit test failures. +Any proposed code change will be automatically rejected by the OpenDev +Zuul project gating system [#f1]_ if the change causes unit test failures. Functional Tests ~~~~~~~~~~~~~~~~ @@ -210,7 +210,7 @@ Therefore, it is preferable to use: .. rubric:: Footnotes -.. [#f1] See :doc:`jenkins`. +.. [#f1] See :doc:`zuul`. Debugging diff --git a/doc/source/contributor/zuul.rst b/doc/source/contributor/zuul.rst new file mode 100644 index 00000000000..6de1a2c14f5 --- /dev/null +++ b/doc/source/contributor/zuul.rst @@ -0,0 +1,42 @@ +Continuous Integration with Zuul +================================ + +Cinder uses `Zuul`_ as project gating system. The Zuul web front-end is at +https://status.opendev.org. + +Zuul ensures that only tested code gets merged. The configuration is +mainly done in `cinder's .zuul.yaml`_ file. + +The following is a partial list of jobs that are configured to run on +changes. Test jobs run initially on proposed changes and get run again +after review and approval. Note that for each job run the code gets +rebased to current HEAD to test exactly the state that gets merged. + +openstack-tox-pep8 + Run linters like PEP8 checks. + +openstack-tox-pylint + Run Pylint checks. + +openstack-tox-python27 + Run unit tests using python2.7. + +openstack-tox-python36 + Run unit tests using python3.6. + +openstack-tox-docs + Build this documentation for review. + +The following jobs are some of the jobs that run after a change is +merged: + +publish-openstack-tox-docs + Build this documentation and publish to + `OpenStack Cinder `_. + +publish-openstack-python-branch-tarball + Do ``python setup.py sdist`` to create a tarball of the cinder code and + upload it to http://tarballs.openstack.org/cinder. + +.. _Zuul: https://zuul-ci.org +.. _cinder's .zuul.yaml: https://opendev.org/openstack/cinder/src/.zuul.yaml