5aff8cee30
- Use a Sphinx/Myst {include} directive to pull the text from all previous
RELEASE files into the output, which makes the website sidebar index work
properly.
- Exclude the RELEASE files from the files given to RTD to publish, they
aren't needed now and generate warnings if included.
- Updated the intro paragraph in all RELEASE files.
139 lines
3.6 KiB
Perl
139 lines
3.6 KiB
Perl
#!/usr/bin/env perl
|
|
#*************************************************************************
|
|
# Copyright (c) 2025 UChicago Argonne LLC, as Operator of Argonne
|
|
# National Laboratory.
|
|
# SPDX-License-Identifier: EPICS
|
|
# EPICS BASE is distributed subject to a Software License Agreement found
|
|
# in file LICENSE that is included with this distribution.
|
|
#*************************************************************************
|
|
|
|
# Tool to combine release note entries into a single markdown file.
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
use File::Basename;
|
|
use Getopt::Std;
|
|
use version;
|
|
|
|
my $tool = basename($0);
|
|
|
|
our ($opt_d, $opt_h, $opt_o, $opt_D, $opt_V);
|
|
|
|
sub HELP_MESSAGE {
|
|
print STDERR "Usage: $tool -d new-notes -o outfile.md -D " .
|
|
"-V 7.0.10 RELEASE-7.0.9.md ...\n";
|
|
exit 2;
|
|
}
|
|
|
|
HELP_MESSAGE()
|
|
if !getopts('hd:o:DV:') || $opt_h || (!$opt_D && @ARGV > 0);
|
|
|
|
die "$tool: Directory from '-d' option doesn't exist\n"
|
|
unless -d $opt_d;
|
|
die "$tool: Output filename is '$opt_o' but must end with '.md'"
|
|
unless $opt_o =~ m/\.md$/;
|
|
|
|
open my $out, '>:encoding(UTF-8)', $opt_o or
|
|
die "$tool: Can't create $opt_o: $!\n";
|
|
|
|
$SIG{__DIE__} = sub {
|
|
die @_ if $^S; # Ignore eval deaths
|
|
close $out;
|
|
unlink $opt_o;
|
|
};
|
|
|
|
my $REL_VERS = $opt_V;
|
|
$REL_VERS .= '-DEV' if $opt_D;
|
|
|
|
# Directory handle for scanning the new-notes directory
|
|
opendir my $dh, $opt_d or
|
|
die "$tool: Can't open '-d' directory: $!\n";
|
|
|
|
my @notes;
|
|
foreach my $fn ( sort grep !/^\.\.?$/, readdir $dh ) {
|
|
next if $fn eq 'README.txt';
|
|
die "$tool: Not markdown? File '$fn' lacks '.md' extension\n"
|
|
unless $fn =~ m/\.md$/;
|
|
local $/;
|
|
my $file = "$opt_d/$fn";
|
|
push @notes, do {
|
|
open my $fh, '<:encoding(UTF-8)', $file or
|
|
die "$tool: Can't open file $file: $!\n";
|
|
<$fh>;
|
|
};
|
|
}
|
|
close $dh;
|
|
|
|
sub relVers {
|
|
$_ = shift;
|
|
m/RELEASE-([0-9.]+)\.md/;
|
|
return $1;
|
|
}
|
|
|
|
# Reverse sort of the RELEASE-<version>.md filenames
|
|
my @OLD_REL_FILES = sort {
|
|
version->parse(relVers($b)) <=> version->parse(relVers($a));
|
|
} @ARGV;
|
|
|
|
print $out <<"__REL_INTRO__";
|
|
# Release Notes
|
|
|
|
This document describes the changes that were included in the release of EPICS
|
|
noted below. Release entries are now provided in a separate document for each
|
|
version in the EPICS 7 series, but all are combined into a single page for
|
|
publishing on the EPICS website. Separate release documents are also included
|
|
from the older Base 3.15 and 3.16 series.
|
|
|
|
The external PVA submodules continue to maintain their own release notes files
|
|
as before, but the entries describing changes in those submodules since version
|
|
7.0.5 have been copied into the associated EPICS Release Notes files; they will
|
|
also be manually added to new EPICS Release Notes published in the future.
|
|
|
|
__REL_INTRO__
|
|
|
|
print $out <<"__NEW_INTRO__" if $opt_D && scalar @notes;
|
|
|
|
## EPICS Release $REL_VERS
|
|
|
|
__This version of EPICS has not been released yet.__
|
|
__When the changes described below get released, the version number used may be
|
|
different to the one given above.__
|
|
|
|
The changes below have been merged into EPICS since the last published release.
|
|
|
|
__NEW_INTRO__
|
|
|
|
# Include the text from all the new entries
|
|
print $out map { "$_\n" } @notes;
|
|
|
|
# Add myst include directives to incorporate older release files
|
|
foreach my $rfile (@OLD_REL_FILES) {
|
|
my $ver = relVers($rfile);
|
|
if ($ver =~ m/^7\./) {
|
|
print $out <<"__OLD_RELEASE_7__";
|
|
-----
|
|
|
|
## EPICS Release $ver
|
|
|
|
```{include} ../$rfile
|
|
:start-after: EPICS Release $ver
|
|
```
|
|
|
|
__OLD_RELEASE_7__
|
|
}
|
|
elsif ($ver =~ m/^3\.1[56]/) {
|
|
print $out <<"__OLD_RELEASE_3__";
|
|
-----
|
|
|
|
```{include} ../$rfile
|
|
:heading-offset: 1
|
|
```
|
|
|
|
__OLD_RELEASE_3__
|
|
}
|
|
}
|
|
|
|
close $out;
|
|
|