Skip to content

Fix build of release notes #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Feb 28, 2023
Merged

Fix build of release notes #410

merged 2 commits into from
Feb 28, 2023

Conversation

priteau
Copy link
Member

@priteau priteau commented Feb 28, 2023

No description provided.

@priteau
Fix build of release notes
1366500 
Because we turn warnings into errors (sphinx-build -W), the following
warning breaks the build:

    stackhpc-kayobe-config/releasenotes/source/xena.rst:3: WARNING: Duplicate explicit target name: "pr".

This is caused by the use of a single underscore at the end of links
using the same reference: in this case, "PR", resulting in the duplicate
target name "pr". Switch to anonymous hyperlink references with two
underscores instead of one [1].

[1] https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#anonymous-hyperlinks
@priteau
Remove extra new lines in release notes
2f0f20c
@priteau priteau requested a review from jovial February 28, 2023 05:54
@priteau priteau requested a review from a team as a code owner February 28, 2023 05:54
@priteau priteau self-assigned this Feb 28, 2023
@priteau
Copy link
Member Author

priteau commented Feb 28, 2023

Release note build failed in CI, but I think it may work once merged. Reno looks at the actual branch, e.g. stackhpc/xena, instead of the topic branch. It works locally when I commit to stackhpc/xena.

jackhodgkiss
jackhodgkiss approved these changes Feb 28, 2023
View reviewed changes
Copy link
Contributor

@jackhodgkiss jackhodgkiss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@priteau priteau merged commit 484be43 into stackhpc/xena Feb 28, 2023
@priteau priteau deleted the reno-fix branch February 28, 2023 15:03
@markgoddard
Copy link
Contributor

Release note build failed in CI, but I think it may work once merged. Reno looks at the actual branch, e.g. stackhpc/xena, instead of the topic branch. It works locally when I commit to stackhpc/xena.

Seems like a bug - shouldn't it use the PR branch if we want to test added renos?

@priteau
Copy link
Member Author

priteau commented Mar 1, 2023

Release note build failed in CI, but I think it may work once merged. Reno looks at the actual branch, e.g. stackhpc/xena, instead of the topic branch. It works locally when I commit to stackhpc/xena.

Seems like a bug - shouldn't it use the PR branch if we want to test added renos?

Possibly Zuul does something different to allow generating release notes during CI jobs?

Also we may be hitting limitations of Reno's design, since we don't seem to follow its expected workflow: https://docs.openstack.org/reno/latest/user/design.html#assumptions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bbezak bbezak bbezak approved these changes

@jackhodgkiss jackhodgkiss jackhodgkiss approved these changes

@jovial jovial Awaiting requested review from jovial

Assignees

@priteau priteau

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@priteau @markgoddard @bbezak @jackhodgkiss