db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-10-30 23:37:45 +02:00
Code Issues Releases Activity

Split "refactor" sections into "improvements" and "development" in the release notes.

Browse Source 
Many development notes are not relevant to users and simply clutter the release notes, so they are no longer shown on the website.
This commit is contained in:
David Steele
2017-11-25 20:32:35 -05:00
parent 13893a9731
commit c360ca5a08
4 changed files with 380 additions and 354 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/lib/BackRestDoc/Common/DocRender.pm
View File

@@ -218,7 +218,8 @@ sub new
BackRestDoc::Custom::DocCustomRelease->import();
$self->{oDoc} =
(new BackRestDoc::Custom::DocCustomRelease(${$self->{oManifest}->sourceGet('release')}{doc}, $self))->docGet();
(new BackRestDoc::Custom::DocCustomRelease(
${$self->{oManifest}->sourceGet('release')}{doc}, $self->{oManifest}->keywordMatch('dev')))->docGet();
}
else
{

52
doc/lib/BackRestDoc/Custom/DocCustomRelease.pm
View File

@@ -30,8 +30,9 @@ use constant XML_RELEASE_DOC_LIST => 'release-
use constant XML_RELEASE_TEST_LIST => 'release-test-list';
use constant XML_RELEASE_BUG_LIST => 'release-bug-list';
use constant XML_RELEASE_DEVELOPMENT_LIST => 'release-development-list';
use constant XML_RELEASE_FEATURE_LIST => 'release-feature-list';
use constant XML_RELEASE_REFACTOR_LIST => 'release-refactor-list';
use constant XML_RELEASE_IMPROVEMENT_LIST => 'release-improvement-list';
use constant XML_RELEASE_ITEM_CONTRIBUTOR_LIST => 'release-item-contributor-list';
@@ -62,12 +63,14 @@ sub new
# Assign function parameters, defaults, and log debug info
(
my $strOperation,
$self->{oDoc}
$self->{oDoc},
$self->{bDev},
) =
logDebugParam
(
__PACKAGE__ . '->new', \@_,
{name => 'oDoc'}
{name => 'oDoc'},
{name => 'bDev', required => false, default => false},
);
# Get contributor list
@@ -358,6 +361,7 @@ sub docGet
# Add release sections
my $bAdditionalNotes = false;
my $bReleaseNote = false;
my $hSectionType =
{
@@ -370,42 +374,44 @@ sub docGet
{
if ($oRelease->nodeTest($strSectionType))
{
# Create subsections for any release section other than core. This breaks up the release items.
my $oSubSection = $oReleaseSection;
if ($strSectionType ne XML_RELEASE_CORE_LIST && !$bAdditionalNotes)
{
$oReleaseSection->nodeAdd('subtitle')->textSet("Additional Notes");
$bAdditionalNotes = true;
}
# Add release note if present
if ($oRelease->nodeGet($strSectionType)->nodeTest('p'))
{
$oSubSection->nodeAdd('p')->textSet($oRelease->nodeGet($strSectionType)->nodeGet('p')->textGet());
}
# Add release item types
my $hItemType =
{
&XML_RELEASE_BUG_LIST => {title => 'Bug Fixes', type => 'bug'},
&XML_RELEASE_FEATURE_LIST => {title => 'Features', type=> 'feature'},
&XML_RELEASE_REFACTOR_LIST => {title => 'Refactoring', type=> 'refactor'},
&XML_RELEASE_FEATURE_LIST => {title => 'Features', type => 'feature'},
&XML_RELEASE_IMPROVEMENT_LIST => {title => 'Improvements', type => 'improvement'},
&XML_RELEASE_DEVELOPMENT_LIST => {title => 'Development', type => 'development'},
};
foreach my $strItemType (XML_RELEASE_BUG_LIST, XML_RELEASE_FEATURE_LIST, XML_RELEASE_REFACTOR_LIST)
foreach my $strItemType (
XML_RELEASE_BUG_LIST, XML_RELEASE_FEATURE_LIST, XML_RELEASE_IMPROVEMENT_LIST, XML_RELEASE_DEVELOPMENT_LIST)
{
next if (!$self->{bDev} && $strItemType eq XML_RELEASE_DEVELOPMENT_LIST);
if ($oRelease->nodeGet($strSectionType)->nodeTest($strItemType))
{
if ($strSectionType ne XML_RELEASE_CORE_LIST && !$bAdditionalNotes)
{
$oReleaseSection->nodeAdd('subtitle')->textSet('Additional Notes');
$bAdditionalNotes = true;
}
# Add release note if present
if (!$bReleaseNote && $oRelease->nodeGet($strSectionType)->nodeTest('p'))
{
$oReleaseSection->nodeAdd('p')->textSet($oRelease->nodeGet($strSectionType)->nodeGet('p')->textGet());
$bReleaseNote = true;
}
my $strTypeText =
($strSectionType eq XML_RELEASE_CORE_LIST ? '' : $$hSectionType{$strSectionType}{title}) . ' ' .
$$hItemType{$strItemType}{title} . ':';
$oSubSection->
$oReleaseSection->
nodeAdd('p')->textSet(
{name => 'text', children=> [{name => 'b', value => $strTypeText}]});
my $oList = $oSubSection->nodeAdd('list');
my $oList = $oReleaseSection->nodeAdd('list');
# Add release items
foreach my $oReleaseFeature ($oRelease->nodeGet($strSectionType)->

9
doc/xml/dtd/doc.dtd
View File

@@ -152,13 +152,14 @@
<!ATTLIST release version CDATA #REQUIRED>
<!ATTLIST release title CDATA #REQUIRED>
<!ELEMENT release-core-list (p?, release-bug-list?, release-feature-list?, release-refactor-list?)>
<!ELEMENT release-test-list (p?, release-bug-list?, release-feature-list?, release-refactor-list?)>
<!ELEMENT release-doc-list (p?, release-bug-list?, release-feature-list?, release-refactor-list?)>
<!ELEMENT release-core-list (p?, release-bug-list?, release-feature-list?, release-improvement-list?, release-development-list?)>
<!ELEMENT release-test-list (p?, release-feature-list?, release-improvement-list?, release-development-list?)>
<!ELEMENT release-doc-list (p?, release-bug-list?, release-feature-list?, release-improvement-list?, release-development-list?)>
<!ELEMENT release-bug-list (release-item+)>
<!ELEMENT release-feature-list (release-item+)>
<!ELEMENT release-refactor-list (release-item+)>
<!ELEMENT release-improvement-list (release-item+)>
<!ELEMENT release-development-list (release-item+)>
<!ELEMENT release-item (release-item-contributor-list?, p)*>

670
doc/xml/release.xml
View File

File diff suppressed because it is too large Load Diff