Skip to content

Commit

Permalink
Set an explicit branch on release notes directive (#175)
Browse files Browse the repository at this point in the history
This commit sets an explicit branch on the reno directive for the docs
build. Without this for the first 0.1.0 release the reno history search
is incorrectly treating the stable/0.1 branch as the origin point for
the history and it is not finding any of the release notes for 0.1
because it's not before the branch point of the stable branch. To fix
workaround this issue, this commit explicitly sets the branch to use for
the release notes to main, this will work only for docs builds on main
as it might have unintended consequences for stable patch releases. We
might need to revert this if/when a 0.1.1 release goes out to ensure the
history scan finds stable branch release notes.
  • Loading branch information
mtreinish committed Feb 28, 2022
1 parent fd741a3 commit 2fb0b05
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/release_notes.rst
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.. release-notes:: Release Notes
:branch: main

0 comments on commit 2fb0b05

Please sign in to comment.