← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1774508] Re: Documentation warnings are treated as errors and failing check/gate jobs

 

Reviewed:  https://review.openstack.org/571369
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=488ecef3296f3a1c17df7431de315c0c3cf2b226
Submitter: Zuul
Branch:    master

commit 488ecef3296f3a1c17df7431de315c0c3cf2b226
Author: wangxiyuan <wangxiyuan@xxxxxxxxxx>
Date:   Thu May 31 11:21:42 2018 +0800

    Fix warnings in documentation
    
    A recent change defaults the warning-as-error to True:
    
      https://review.openstack.org/#/c/559348/
    
    Which is causing our documentation jobs to fail locally and in the
    gate/check queues.
    
    This commit fixes both issues that are causing failures so that
    we can get the doc jobs passing again.
    
    Closes-Bug: 1774508
    Change-Id: Ic1eff48a6f40aa315cc5e566a0f9e930a20b9837


** Changed in: keystone
       Status: In Progress => Fix Released

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Identity (keystone).
https://bugs.launchpad.net/bugs/1774508

Title:
  Documentation warnings are treated as errors and failing check/gate
  jobs

Status in OpenStack Identity (keystone):
  Fix Released

Bug description:
  Keystone has some warnings when building documentation. The first is
  because we don't install an optional dependency for ldappool/pyldap.
  The second is because we included invalid json in a piece of
  documentation [0].

  Since they were being treated as warnings, they weren't failing check
  and gate jobs. When the PTI stuff landed some changes were made that
  defaults warning-as-error to True [1], which recently merged [2].

  As a result, our documentation jobs are failing with things like:

  http://paste.openstack.org/raw/722475/
  http://paste.openstack.org/raw/722477/

  We should address these warning to get those jobs passing again.

  [0] https://review.openstack.org/#/c/559438/12/doc/source/admin/identity-security-compliance.rst@240
  [1] http://lists.openstack.org/pipermail/openstack-dev/2018-May/130897.html
  [2] https://review.openstack.org/#/c/559348/

To manage notifications about this bug go to:
https://bugs.launchpad.net/keystone/+bug/1774508/+subscriptions


References