From patchwork Fri Jun 25 14:48:47 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aaron Conole X-Patchwork-Id: 1497335 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=140.211.166.138; helo=smtp1.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=UP5S178n; dkim-atps=neutral Received: from smtp1.osuosl.org (smtp1.osuosl.org [140.211.166.138]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4GBKdX45R6z9sX5 for ; Sat, 26 Jun 2021 00:49:04 +1000 (AEST) Received: from localhost (localhost [127.0.0.1]) by smtp1.osuosl.org (Postfix) with ESMTP id 9016983DE6; Fri, 25 Jun 2021 14:49:01 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp1.osuosl.org ([127.0.0.1]) by localhost (smtp1.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 4eJA22O35_ff; Fri, 25 Jun 2021 14:49:00 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by smtp1.osuosl.org (Postfix) with ESMTPS id A79FF83DCF; Fri, 25 Jun 2021 14:48:59 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 78898C0010; Fri, 25 Jun 2021 14:48:59 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from smtp1.osuosl.org (smtp1.osuosl.org [140.211.166.138]) by lists.linuxfoundation.org (Postfix) with ESMTP id B3054C000E for ; Fri, 25 Jun 2021 14:48:58 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp1.osuosl.org (Postfix) with ESMTP id 8D45E83DD6 for ; Fri, 25 Jun 2021 14:48:58 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp1.osuosl.org ([127.0.0.1]) by localhost (smtp1.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id vZa4kfuhCkxQ for ; Fri, 25 Jun 2021 14:48:56 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.8.0 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by smtp1.osuosl.org (Postfix) with ESMTPS id 7CFE883DCF for ; Fri, 25 Jun 2021 14:48:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1624632535; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=cbs2WY6kx5cZTPHNCDllXdmCxBdi0pzqaYyYfX8P6ME=; b=UP5S178n8ttH7JQP1BkawhjN9Ft5MwwulSLjd/mmF1Q2mUAe5QG1+VhDuTk7M07lWJmSSW YTjfVc1L7Gp1NhjmbCHEW0soJhYef+sNcdb1d99/z1Dow5eaEeYLipr2RDqCBMXyBB53Ok tytjJaQ7H3OI8WXvEqF1dCN/Yi8chCI= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-435-UsFGVD1mOXaxrPbVxYQryA-1; Fri, 25 Jun 2021 10:48:52 -0400 X-MC-Unique: UsFGVD1mOXaxrPbVxYQryA-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 910BA802C92; Fri, 25 Jun 2021 14:48:50 +0000 (UTC) Received: from RHTPC1VM0NT.lan (ovpn-113-104.rdu2.redhat.com [10.10.113.104]) by smtp.corp.redhat.com (Postfix) with ESMTP id 37E6860938; Fri, 25 Jun 2021 14:48:48 +0000 (UTC) From: Aaron Conole To: dev@openvswitch.org Date: Fri, 25 Jun 2021 10:48:47 -0400 Message-Id: <20210625144847.393971-1-aconole@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=aconole@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Cc: Thomas Graf , Ilya Maximets Subject: [ovs-dev] [RFC] Documentation: minimize travis as our testing infrastructure X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ovs-dev-bounces@openvswitch.org Sender: "dev" 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 CI solution. Signed-off-by: Aaron Conole Refs: https://mail.openvswitch.org/pipermail/ovs-dev/2021-June/384040.html --- 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 --- a/Documentation/internals/contributing/submitting-patches.rst +++ b/Documentation/internals/contributing/submitting-patches.rst @@ -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. Email Subject ------------- diff --git a/Documentation/topics/testing.rst b/Documentation/topics/testing.rst index 951fe9e851..9894a3f7c5 100644 --- a/Documentation/topics/testing.rst +++ b/Documentation/topics/testing.rst @@ -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 -travis-ci. - -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@mydomain.org - 3. Add/replace the notifications section in .travis.yml and fill in the - secure string as returned by travis encrypt:: - - notifications: - email: - recipients: - - 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@mydomain.org +Continuous Integration +---------------------- + +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 +owner. + +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. vsperf ------ diff --git a/README.rst b/README.rst index 319f705154..8e64d74aee 100644 --- a/README.rst +++ b/README.rst @@ -8,8 +8,6 @@ Open vSwitch .. image:: https://github.com/openvswitch/ovs/workflows/Build%20and%20Test/badge.svg :target: https://github.com/openvswitch/ovs/actions -.. 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 :target: https://ci.appveyor.com/project/blp/ovs/history .. image:: https://api.cirrus-ci.com/github/openvswitch/ovs.svg