← Back to team overview

yahoo-eng-team team mailing list archive

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

 

Public bug reported:

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/

** Affects: keystone
     Importance: High
     Assignee: wangxiyuan (wangxiyuan)
         Status: In Progress


** Tags: documentation

** Changed in: keystone
       Status: New => Confirmed

** Changed in: keystone
   Importance: Undecided => High

** Description changed:

  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 regularly. When the PTI stuff landed some changes were
- made that default warning-as-error to True [1], which recently merged
- [2].
+ and gate jobs. When the PTI stuff landed some changes were made that
+ default 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/

** Description changed:

  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
- default warning-as-error to True [1], which recently merged [2].
+ 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/

-- 
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):
  In Progress

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


Follow ups