[ovs-dev] [RFC] Documentation: minimize travis as our testing infrastructure
aconole at redhat.com
Fri Jun 25 14:48:47 UTC 2021
Recently, Travis-CI has retired the travis-ci.org service. At the
moment, it is read-only. In the future, it may disappear completely.
Travis-CI might still be useful for individual developers testing small
patches, but can no longer fulfill the role of project-wide continuous
integration service. Remove the badge from the front page, and note the
other CI services that OVS supports. Rather than completely drop all
references to travis, simply emphasize using GitHub Actions as the preferred
Signed-off-by: Aaron Conole <aconole at redhat.com>
NOTE: I waffled on completely removing references to Travis, and dropping
the .travis.yml file completely. I'm not opposed, but maybe it should
just be done with.
.../contributing/submitting-patches.rst | 8 +--
Documentation/topics/testing.rst | 68 ++++++++-----------
README.rst | 2 -
3 files changed, 33 insertions(+), 45 deletions(-)
diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst
index 4a6780371d..a6a10f8d89 100644
@@ -68,10 +68,10 @@ Testing is also important:
feature. A bug fix patch should preferably add a test that would
fail if the bug recurs.
-If you are using GitHub, then you may utilize the travis-ci.org and the GitHub
-Actions CI build systems. They will run some of the above tests automatically
-when you push changes to your repository. See the "Continuous Integration with
-Travis-CI" in :doc:`/topics/testing` for details on how to set it up.
+If you are using GitHub, then you may utilize the the GitHub Actions CI build
+systems. They will run some of the above tests automatically when you push
+changes to your repository. See the "Continuous Integration" section in
+:doc:`/topics/testing` for details on continuous integration.
diff --git a/Documentation/topics/testing.rst b/Documentation/topics/testing.rst
index 951fe9e851..9894a3f7c5 100644
@@ -416,45 +416,35 @@ You should invoke scan-view to view analysis results. The last line of output
from ``clang-analyze`` will list the command (containing results directory)
that you should invoke to view the results on a browser.
-Continuous Integration with Travis CI
-A .travis.yml file is provided to automatically build Open vSwitch with various
-build configurations and run the testsuite using Travis CI. Builds will be
-performed with gcc, sparse and clang with the -Werror compiler flag included,
-therefore the build will fail if a new warning has been introduced.
-The CI build is triggered via git push (regardless of the specific branch) or
-pull request against any Open vSwitch GitHub repository that is linked to
-Instructions to setup travis-ci for your GitHub repository:
-1. Go to https://travis-ci.org/ and sign in using your GitHub ID.
-2. Go to the "Repositories" tab and enable the ovs repository. You may disable
- builds for pushes or pull requests.
-3. In order to avoid forks sending build failures to the upstream mailing list,
- the notification email recipient is encrypted. If you want to receive email
- notification for build failures, replace the encrypted string:
- 1. Install the travis-ci CLI (Requires ruby >=2.0): gem install travis
- 2. In your Open vSwitch repository: travis encrypt mylist at mydomain.org
- 3. Add/replace the notifications section in .travis.yml and fill in the
- secure string as returned by travis encrypt::
- - secure: "....."
- .. note::
- You may remove/omit the notifications section to fall back to default
- notification behaviour which is to send an email directly to the author and
- committer of the failing commit. Note that the email is only sent if the
- author/committer have commit rights for the particular GitHub repository.
-4. Pushing a commit to the repository which breaks the build or the
- testsuite will now trigger a email sent to mylist at mydomain.org
+The Open vSwitch project can make use of multiple public CI services to help
+developers ensure their patches don't introduce additional regressions. Each
+service requires different forms of configuration, and for the supported
+services the configuration file(s) to automatically build Open vSwitch with
+various build configurations and run the testsuites is/are available. For
+example, the GitHub Actions builds will be performed with gcc, sparse and clang
+with the -Werror compiler flag included, therefore the build will fail if a new
+warning has been introduced.
+Each ci system uses a different method of enablement, but most are available
+from the GitHub settings page. By default, Open vSwitch includes a GitHub
+actions running configuration, and this will automatically email the repository
+Currently, Open vSwitch project enables the following public CI services along
+with the appropriate configuration settings::
+ - AppVeyor: appveyor.yml
+ - Cirrus-CI: .cirrus.yml
+ - GitHub Actions: .github/workflows
+ - Travis-CI: .travis.yml
+GitHub Actions is available without any additional configuration.
+Additionally, as each patch is posted to the mailing list, the public CI
+machinery will run additional tests on the patches and report results.
diff --git a/README.rst b/README.rst
index 319f705154..8e64d74aee 100644
@@ -8,8 +8,6 @@ Open vSwitch
.. image:: https://github.com/openvswitch/ovs/workflows/Build%20and%20Test/badge.svg
-.. image:: https://travis-ci.org/openvswitch/ovs.png
- :target: https://travis-ci.org/openvswitch/ovs
.. image:: https://ci.appveyor.com/api/projects/status/github/openvswitch/ovs?branch=master&svg=true&retina=true
.. image:: https://api.cirrus-ci.com/github/openvswitch/ovs.svg
More information about the dev