Skip to content

Commit

Permalink
fix(docs): fix broken docs builds for 1.0 branch (DataDog#3363)
Browse files Browse the repository at this point in the history
* fix(docs): fix duplicate release note existing for 0.59 and 1.0

* fix(reno): set correct default branch name

* fix(docs): build all release notes for spell checking in a different file

* Update releasenotes/notes/remove-span-get-set-meta-c6fb2528d198414d.yaml

Co-authored-by: Tahir H. Butt <[email protected]>

Co-authored-by: Tahir H. Butt <[email protected]>
  • Loading branch information
brettlangdon and majorgreys authored Mar 3, 2022
1 parent 5b7ed81 commit 0ade4bd
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 15 deletions.
1 change: 1 addition & 0 deletions docs/_release_notes_all.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. release-notes::
11 changes: 10 additions & 1 deletion docs/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,16 @@ Release Notes
.. only:: spelling

.. release-notes::
.. toctree::
:hidden:

_release_notes_all



.. release-notes::
:branch: 1.0
:earliest-version: v1.0.0rc1

.. release-notes::
:branch: 0.59
Expand Down
1 change: 1 addition & 0 deletions releasenotes/config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
default_branch: origin/1.x
unreleased_version_title: Unreleased

# The default is: (?P<pre_release>\.v?\d+(?:[ab]|rc)+\d*)$
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
---
deprecations:
- ".. _remove-span-set-meta:
``ddtrace.Span.set_meta`` is removed. Use :py:meth:`ddtrace.Span.set_tag`
instead.
"
- ".. _remove-span-set-metas:
``ddtrace.Span.set_metas`` is removed. Use :py:meth:`ddtrace.Span.set_tags`
instead.
"
- |
:py:meth:`ddtrace.Span.set_meta` is deprecated. Use :py:meth:`ddtrace.Span.set_tag` instead.
- |
:py:meth:`ddtrace.Span.set_metas` is deprecated. Use :py:meth:`ddtrace.Span.set_tags` instead.
16 changes: 16 additions & 0 deletions releasenotes/notes/remove-span-get-set-meta-c6fb2528d198414d.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
upgrade:
- ".. _remove-span-set-meta:
``ddtrace.Span.set_meta`` is removed. Use :py:meth:`ddtrace.Span.set_tag`
instead.
"
- ".. _remove-span-set-metas:
``ddtrace.Span.set_metas`` is removed. Use :py:meth:`ddtrace.Span.set_tags`
instead.
"

0 comments on commit 0ade4bd

Please sign in to comment.