Emphasized pre-releases in release notes.

VUnit · Jul 21, 2024 · 5e1f88a · 5e1f88a
1 parent bd4971c
commit 5e1f88a
Show file tree

Hide file tree

Showing 52 changed files with 6 additions and 70 deletions.
diff --git a/docs/create_release_notes.py b/docs/create_release_notes.py
@@ -13,7 +13,6 @@
 from shutil import which
 from datetime import datetime
 
-
 def create_release_notes():
     """
     Create monolithic release notes file from several input files
@@ -36,7 +35,10 @@ def create_release_notes():
     )
 
     for idx, release in enumerate(releases):
-        title = f":vunit_commit:`{release.name!s} <v{release.name!s}>` - {release.date.strftime('%Y-%m-%d')}"
+        title = f":vunit_commit:`{release.name!s} <v{release.name!s}>` - "
+        if release.is_pre_release:
+            title += "PRE-RELEASE - "
+        title += f"{release.date.strftime('%Y-%m-%d')}"
 
         if idx == 0:
             title += " (latest)"
@@ -68,7 +70,8 @@ class Release(object):
     def __init__(self, file_name, is_latest):
         self.suffix = file_name.suffix
         self.name = file_name.stem
-        tag = "v" + self.name
+        self.is_pre_release = "dev" in self.name
+        tag = "v" + self.name.replace(".dev", "-dev.")
 
         git = which("git")
         if git is None:

diff --git a/docs/news.d/+.deprecation.rst b/docs/news.d/+.deprecation.rst
diff --git a/docs/news.d/+cc958f43.misc.rst b/docs/news.d/+cc958f43.misc.rst
diff --git a/docs/news.d/1001.bugfix.rst b/docs/news.d/1001.bugfix.rst
diff --git a/docs/news.d/1004.feature.rst b/docs/news.d/1004.feature.rst
diff --git a/docs/news.d/1005.feature.rst b/docs/news.d/1005.feature.rst
diff --git a/docs/news.d/1007.feature.rst b/docs/news.d/1007.feature.rst
diff --git a/docs/news.d/1018.bugfix.rst b/docs/news.d/1018.bugfix.rst
diff --git a/docs/news.d/1025.feature.rst b/docs/news.d/1025.feature.rst
diff --git a/docs/news.d/1026.misc.rst b/docs/news.d/1026.misc.rst
diff --git a/docs/news.d/1032.feature.rst b/docs/news.d/1032.feature.rst
diff --git a/docs/news.d/1033.feature.rst b/docs/news.d/1033.feature.rst
diff --git a/docs/news.d/1036.feature.rst b/docs/news.d/1036.feature.rst
diff --git a/docs/news.d/1039.feature.rst b/docs/news.d/1039.feature.rst
diff --git a/docs/news.d/179.feature.rst b/docs/news.d/179.feature.rst
diff --git a/docs/news.d/559.breaking.rst b/docs/news.d/559.breaking.rst
diff --git a/docs/news.d/600.breaking.rst b/docs/news.d/600.breaking.rst
diff --git a/docs/news.d/742.breaking.rst b/docs/news.d/742.breaking.rst
diff --git a/docs/news.d/764.breaking.rst b/docs/news.d/764.breaking.rst
diff --git a/docs/news.d/764.doc.rst b/docs/news.d/764.doc.rst
diff --git a/docs/news.d/776.feature.rst b/docs/news.d/776.feature.rst
diff --git a/docs/news.d/777.breaking.rst b/docs/news.d/777.breaking.rst
diff --git a/docs/news.d/798.bugfix.rst b/docs/news.d/798.bugfix.rst
diff --git a/docs/news.d/799.bugfix.rst b/docs/news.d/799.bugfix.rst
diff --git a/docs/news.d/802.feature.rst b/docs/news.d/802.feature.rst
diff --git a/docs/news.d/889.bugfix.rst b/docs/news.d/889.bugfix.rst
diff --git a/docs/news.d/909.feature.rst b/docs/news.d/909.feature.rst
diff --git a/docs/news.d/924.bugfix.rst b/docs/news.d/924.bugfix.rst
diff --git a/docs/news.d/932.breaking.rst b/docs/news.d/932.breaking.rst
diff --git a/docs/news.d/933.breaking.rst b/docs/news.d/933.breaking.rst
diff --git a/docs/news.d/940.misc.rst b/docs/news.d/940.misc.rst
diff --git a/docs/news.d/946.feature.rst b/docs/news.d/946.feature.rst
diff --git a/docs/news.d/947.feature.rst b/docs/news.d/947.feature.rst
diff --git a/docs/news.d/948.feature.rst b/docs/news.d/948.feature.rst
diff --git a/docs/news.d/949.feature.rst b/docs/news.d/949.feature.rst
diff --git a/docs/news.d/951.feature.rst b/docs/news.d/951.feature.rst
diff --git a/docs/news.d/954.bugfix.rst b/docs/news.d/954.bugfix.rst
diff --git a/docs/news.d/956.bugfix.rst b/docs/news.d/956.bugfix.rst
diff --git a/docs/news.d/965.bugfix.rst b/docs/news.d/965.bugfix.rst
diff --git a/docs/news.d/966.feature.rst b/docs/news.d/966.feature.rst
diff --git a/docs/news.d/967.feature.rst b/docs/news.d/967.feature.rst
diff --git a/docs/news.d/971.bugfix.rst b/docs/news.d/971.bugfix.rst
diff --git a/docs/news.d/972.misc.rst b/docs/news.d/972.misc.rst
diff --git a/docs/news.d/981.misc.rst b/docs/news.d/981.misc.rst
diff --git a/docs/news.d/983.breaking.rst b/docs/news.d/983.breaking.rst
diff --git a/docs/news.d/989.feature.rst b/docs/news.d/989.feature.rst
diff --git a/docs/news.d/991.feature.rst b/docs/news.d/991.feature.rst
diff --git a/docs/news.d/992.misc.rst b/docs/news.d/992.misc.rst
diff --git a/docs/news.d/993.misc.rst b/docs/news.d/993.misc.rst
diff --git a/docs/news.d/994.feature.rst b/docs/news.d/994.feature.rst
diff --git a/docs/news.d/996.misc.rst b/docs/news.d/996.misc.rst
diff --git a/docs/news.d/998.feature.rst b/docs/news.d/998.feature.rst