Skip to content

Commit

Permalink
Documentation : Remove release notes for versions < 1.0.0.0
Browse files Browse the repository at this point in the history
They clutter up search results and provide more history than needed. This also fixes some Myst parser warnings which were coming from the older release notes and which cluttered up the CI annotations pane.
  • Loading branch information
johnhaddon committed Aug 11, 2023
1 parent 4349d9e commit 0f68f45
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
4 changes: 4 additions & 0 deletions Changes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
1.3.x.x (relative to 1.3.1.0)
=======

Documentation
-------------

- Removed release notes for versions prior to 1.0.0.0.

1.3.1.0 (relative to 1.3.0.0)
=======
Expand Down
11 changes: 8 additions & 3 deletions doc/source/ReleaseNotes/generate.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,14 @@

m = re.match( r"^(Gaffer )?(([0-9]+\.){2,3}[0-9]+)", line )
if m :
versionIndex += ( "\n{}{}.md".format( " " * 4, m.group( 2 ) ) )
versionFile = open( m.group( 2 ) + ".md", "w" )
versionFile.write( m.group( 2 ) + "\n" )
versionString = m.group( 2 )
if versionString.startswith( "0." ) or versionString.count( "." ) != 3 :
# Ignore versions prior to 1.0.0.0
versionFile = None
else :
versionIndex += ( f"\n {versionString}.md" )
versionFile = open( f"{versionString}.md", "w" )
versionFile.write( f"{versionString}\n" )
continue

if not versionFile :
Expand Down

0 comments on commit 0f68f45

Please sign in to comment.