tripleo

tripleo-validations README has broken includes

Bug #1774001 reported by Sean McGinnis
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
tripleo
Fix Released
Critical
Alex Schultz
tripleo rocky-2

Bug Description

There are several includes for other files in this repo's README file that do not exist. This hasn't been an issue so far, but it appears pypi recently enabled RST validation on package descriptions. Since the README is pulled in as the description, this now causes failures trying to upload new versions of the package.

Will need to be fixed in master and backported to every stable branch that still gets released.

Revision history for this message
Alex Schultz (alex-schultz) wrote :

This blocks tripleo releases that include tripleo-validations until this is resolved.

Changed in tripleo:
status: New → Triaged
importance: Undecided → Critical
milestone: none → rocky-2
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to tripleo-validations (master)

Fix proposed to branch: master
Review: https://review.openstack.org/570954

Changed in tripleo:
assignee: nobody → Alex Schultz (alex-schultz)
status: Triaged → In Progress
Revision history for this message
Sean McGinnis (sean-mcginnis) wrote :

Also affects tripleo-common.

Revision history for this message
Sean McGinnis (sean-mcginnis) wrote :

Also affects openstack/instack.

Revision history for this message
Sean McGinnis (sean-mcginnis) wrote :

Also affects openstack/tripleo-puppet-elements.

Revision history for this message
Sean McGinnis (sean-mcginnis) wrote :

Nice tip from Monty - the following can be run to validate:

python setup.py check -r -s

We will look at adding this to the docs job to catch these right away.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to tripleo-common (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/570977

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to instack (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/570981

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to tripleo-puppet-elements (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/570984

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to tripleo-image-elements (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/570985

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to tripleo-quickstart (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/570988

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to tripleo-validations (master)

Reviewed: https://review.openstack.org/570954
Committed: https://git.openstack.org/cgit/openstack/tripleo-validations/commit/?id=af792d02e578768ead5139e7c43aaf1bd2b1bd77
Submitter: Zuul
Branch: master

commit af792d02e578768ead5139e7c43aaf1bd2b1bd77
Author: Alex Schultz <email address hidden>
Date: Tue May 29 09:47:47 2018 -0600

    Fix documentations for pypi

    The readme included references to docs files which do not exist outside
    of the built documentation. This change removes the extra docs bit for
    the README.rst and moves the old README.rst to the documentation readme.

    Change-Id: Ic00ca2ccfd66348f6b1d367a55b6318b82849f59
    Closes-Bug: #1774001

Changed in tripleo:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to tripleo-validations (stable/queens)

Fix proposed to branch: stable/queens
Review: https://review.openstack.org/571231

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to instack (master)

Reviewed: https://review.openstack.org/570981
Committed: https://git.openstack.org/cgit/openstack/instack/commit/?id=1dca54c838b759eab1ae7c49871e2bba85dae06c
Submitter: Zuul
Branch: master

commit 1dca54c838b759eab1ae7c49871e2bba85dae06c
Author: Alex Schultz <email address hidden>
Date: Tue May 29 11:26:41 2018 -0600

    Fix readme for package

    The previous readme contained formatting issues for pypi which prevents
    publishing. This change moves the old readme to the docs page and
    simplifies the main README.

    Change-Id: I0bee3951c8c5d7a8d5650c8cfdbf40e9ba6734fc
    Related-Bug: #1774001

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to tripleo-quickstart (master)

Reviewed: https://review.openstack.org/570988
Committed: https://git.openstack.org/cgit/openstack/tripleo-quickstart/commit/?id=dcd32355f4e0debd38608de0b47c17550dacd5d2
Submitter: Zuul
Branch: master

commit dcd32355f4e0debd38608de0b47c17550dacd5d2
Author: Alex Schultz <email address hidden>
Date: Tue May 29 11:50:18 2018 -0600

    Fix readme formatting

    The existing readme works for the docs page but is not valid as a
    standalone document. This change moves the readme into the docs folder
    and reduces what is provided in the main readme.

    $ python setup.py check -r -s
    running check
    warning: check: No role entry for "ref" in module
    "docutils.parsers.rst.languages.en".
    Trying "ref" as canonical role name. (line 129)

    warning: check: Unknown interpreted text role "ref". (line 129)

    warning: check: No role entry for "ref" in module
    "docutils.parsers.rst.languages.en".
    Trying "ref" as canonical role name. (line 146)

    warning: check: Unknown interpreted text role "ref". (line 146)

    warning: check: No role entry for "ref" in module
    "docutils.parsers.rst.languages.en".
    Trying "ref" as canonical role name. (line 149)

    warning: check: Unknown interpreted text role "ref". (line 149)

    warning: check: No role entry for "ref" in module
    "docutils.parsers.rst.languages.en".
    Trying "ref" as canonical role name. (line 158)

    warning: check: Unknown interpreted text role "ref". (line 158)

    error: Please correct your package.

    Change-Id: I95276af7b1cb9c3fc3ef7c334debcde627ec8799
    Related-Bug: #1774001

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to tripleo-puppet-elements (master)

Reviewed: https://review.openstack.org/570984
Committed: https://git.openstack.org/cgit/openstack/tripleo-puppet-elements/commit/?id=51291f1460f6ada6039558c8231de82db0d6cb22
Submitter: Zuul
Branch: master

commit 51291f1460f6ada6039558c8231de82db0d6cb22
Author: Alex Schultz <email address hidden>
Date: Tue May 29 11:34:50 2018 -0600

    Fix readme formatting issues

    $ python setup.py check -r -s
    running check
    warning: check: Unexpected indentation. (line 63)

    error: Please correct your package

    Change-Id: I26057e9e2f86f092e04efd3f56f7d55be937f2de
    Related-Bug: #1774001

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to tripleo-common (master)

Reviewed: https://review.openstack.org/570977
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=8872187d6771c08e0a49f9800d0e6e45bf4ec72c
Submitter: Zuul
Branch: master

commit 8872187d6771c08e0a49f9800d0e6e45bf4ec72c
Author: Alex Schultz <email address hidden>
Date: Tue May 29 11:13:06 2018 -0600

    Fix readme doc

    Recent changes to pypi prevent uploading if the rst has issues.

    $ python setup.py check -r -s
    running check
    warning: check: Title underline too short. (line 42)

    warning: check: Title underline too short. (line 42)

    error: Please correct your package.

    Change-Id: Ia1e014cce3e95ccd065395775370d6c29572466f
    Related-Bug: #1774001

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to tripleo-validations (stable/queens)

Reviewed: https://review.openstack.org/571231
Committed: https://git.openstack.org/cgit/openstack/tripleo-validations/commit/?id=c6f61b2a4489e3b3d1e0bfd224e2f87c27a36e86
Submitter: Zuul
Branch: stable/queens

commit c6f61b2a4489e3b3d1e0bfd224e2f87c27a36e86
Author: Alex Schultz <email address hidden>
Date: Tue May 29 09:47:47 2018 -0600

    Fix documentations for pypi

    The readme included references to docs files which do not exist outside
    of the built documentation. This change removes the extra docs bit for
    the README.rst and moves the old README.rst to the documentation readme.

    Change-Id: Ic00ca2ccfd66348f6b1d367a55b6318b82849f59
    Closes-Bug: #1774001
    (cherry picked from commit af792d02e578768ead5139e7c43aaf1bd2b1bd77)

tags: added: in-stable-queens
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to tripleo-common (stable/queens)

Related fix proposed to branch: stable/queens
Review: https://review.openstack.org/571544

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to tripleo-common (stable/queens)

Reviewed: https://review.openstack.org/571544
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=4279b1b5ab518324132fa2b6ea700345cd6f3617
Submitter: Zuul
Branch: stable/queens

commit 4279b1b5ab518324132fa2b6ea700345cd6f3617
Author: Alex Schultz <email address hidden>
Date: Tue May 29 11:13:06 2018 -0600

    Fix readme doc

    Recent changes to pypi prevent uploading if the rst has issues.

    $ python setup.py check -r -s
    running check
    warning: check: Title underline too short. (line 42)

    warning: check: Title underline too short. (line 42)

    error: Please correct your package.

    Change-Id: Ia1e014cce3e95ccd065395775370d6c29572466f
    Related-Bug: #1774001
    (cherry picked from commit 8872187d6771c08e0a49f9800d0e6e45bf4ec72c)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to tripleo-image-elements (master)

Reviewed: https://review.openstack.org/570985
Committed: https://git.openstack.org/cgit/openstack/tripleo-image-elements/commit/?id=2ac38dd68c6ff77ae95d3247316ff251e56a55bc
Submitter: Zuul
Branch: master

commit 2ac38dd68c6ff77ae95d3247316ff251e56a55bc
Author: Alex Schultz <email address hidden>
Date: Tue May 29 11:36:15 2018 -0600

    Fix readme formating issues

    $ python setup.py check -r -s
    running check
    warning: check: Unexpected indentation. (line 65)

    error: Please correct your package.

    Change-Id: I0ff83476918c00f59c5cf292944a3213e8ee41a9
    Related-Bug: #1774001

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to tripleo-puppet-elements (stable/queens)

Related fix proposed to branch: stable/queens
Review: https://review.openstack.org/571766

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to tripleo-puppet-elements (stable/pike)

Related fix proposed to branch: stable/pike
Review: https://review.openstack.org/571767

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to tripleo-puppet-elements (stable/queens)

Reviewed: https://review.openstack.org/571766
Committed: https://git.openstack.org/cgit/openstack/tripleo-puppet-elements/commit/?id=e78ac476394f3dd3f7bc13ce31896f76711e9811
Submitter: Zuul
Branch: stable/queens

commit e78ac476394f3dd3f7bc13ce31896f76711e9811
Author: Alex Schultz <email address hidden>
Date: Tue May 29 11:34:50 2018 -0600

    Fix readme formatting issues

    $ python setup.py check -r -s
    running check
    warning: check: Unexpected indentation. (line 63)

    error: Please correct your package

    Change-Id: I26057e9e2f86f092e04efd3f56f7d55be937f2de
    Related-Bug: #1774001
    (cherry picked from commit 51291f1460f6ada6039558c8231de82db0d6cb22)

tags: added: in-stable-pike
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to tripleo-puppet-elements (stable/pike)

Reviewed: https://review.openstack.org/571767
Committed: https://git.openstack.org/cgit/openstack/tripleo-puppet-elements/commit/?id=2dc3e32a0e8c7fe8eedf56463342130e3fd6c1d9
Submitter: Zuul
Branch: stable/pike

commit 2dc3e32a0e8c7fe8eedf56463342130e3fd6c1d9
Author: Alex Schultz <email address hidden>
Date: Tue May 29 11:34:50 2018 -0600

    Fix readme formatting issues

    $ python setup.py check -r -s
    running check
    warning: check: Unexpected indentation. (line 63)

    error: Please correct your package

    Change-Id: I26057e9e2f86f092e04efd3f56f7d55be937f2de
    Related-Bug: #1774001
    (cherry picked from commit 51291f1460f6ada6039558c8231de82db0d6cb22)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/tripleo-validations 8.4.2

This issue was fixed in the openstack/tripleo-validations 8.4.2 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/tripleo-validations 9.1.0

This issue was fixed in the openstack/tripleo-validations 9.1.0 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to tripleo-image-elements (stable/queens)

Related fix proposed to branch: stable/queens
Review: https://review.openstack.org/640084

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on tripleo-image-elements (stable/queens)

Change abandoned by Sean McGinnis (<email address hidden>) on branch: stable/queens
Review: https://review.openstack.org/640084
Reason: Being done as a direct change in https://review.openstack.org/#/c/640023/

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to tripleo-validations (stable/pike)

Fix proposed to branch: stable/pike
Review: https://review.opendev.org/658458

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to tripleo-validations (stable/pike)

Reviewed: https://review.opendev.org/658458
Committed: https://git.openstack.org/cgit/openstack/tripleo-validations/commit/?id=6386f85cd38e4e0a2052867fc2d60ad7bb5e13f7
Submitter: Zuul
Branch: stable/pike

commit 6386f85cd38e4e0a2052867fc2d60ad7bb5e13f7
Author: Alex Schultz <email address hidden>
Date: Tue May 29 09:47:47 2018 -0600

    Fix documentations for pypi

    The readme included references to docs files which do not exist outside
    of the built documentation. This change removes the extra docs bit for
    the README.rst and moves the old README.rst to the documentation readme.

    Change-Id: Ic00ca2ccfd66348f6b1d367a55b6318b82849f59
    Closes-Bug: #1774001
    (cherry picked from commit af792d02e578768ead5139e7c43aaf1bd2b1bd77)
    (cherry picked from commit c6f61b2a4489e3b3d1e0bfd224e2f87c27a36e86)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/tripleo-validations 7.4.11

This issue was fixed in the openstack/tripleo-validations 7.4.11 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.