Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update format of new Changelog Entry #1633

Merged
3 commits merged into from
Jun 8, 2021
Merged

Update format of new Changelog Entry #1633

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62572bb
Update format of new Changelog Entry
chidozieononiwu May 25, 2021
9f63951
Add parsing of changelog sections
chidozieononiwu May 29, 2021
df94b47
Update ChangeLog Logic
chidozieononiwu Jun 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions eng/common/scripts/ChangeLog-Operations.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,32 @@ function Get-ChangeLogEntriesFromContent {
$changeLogEntries = [Ordered]@{}
try {
# walk the document, finding where the version specifiers are and creating lists
$changeLogEntry = $null
foreach ($line in $changeLogContent) {
if ($line -match $RELEASE_TITLE_REGEX) {
$changeLogEntry = [pscustomobject]@{
ReleaseVersion = $matches["version"]
ReleaseStatus = $matches["releaseStatus"]
ReleaseTitle = "## {0} {1}" -f $matches["version"], $matches["releaseStatus"]
ReleaseContent = @()
Sections = @{}
}
$changeLogEntries[$changeLogEntry.ReleaseVersion] = $changeLogEntry
}
else {
if ($changeLogEntry) {
if ($line.Trim() -match "^###\s(?<sectionName>.*)")
{
$sectionName = $matches["sectionName"].Trim()
$changeLogEntry.Sections[$sectionName] = @()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there are multiple sections with the same name this will essentially throw out the old section. That might not be a real issue but something to keep in mind.

$changeLogEntry.ReleaseContent += $line
continue
}

if ($sectionName)
{
$changeLogEntry.Sections[$sectionName] += $line
}

$changeLogEntry.ReleaseContent += $line
}
}
Expand Down Expand Up @@ -195,7 +208,19 @@ function New-ChangeLogEntry {
return $null
}

if (!$Content) { $Content = @() }
if (!$Content) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chidozieononiwu one other question that I just thought about is now our verify changelog check that validates that the change log isn't empty should be updated to verify that the change log entry doesn't have all empty sections.

$Content = @()
$Content += ""
chidozieononiwu marked this conversation as resolved.
Show resolved Hide resolved
$Content += "### Features Added"
$Content += ""
$Content += "### Breaking Changes"
$Content += ""
$Content += "### Key Bugs Fixed"
$Content += ""
$Content += "### Fixed"
$Content += ""
$Content += ""
chidozieononiwu marked this conversation as resolved.
Show resolved Hide resolved
}

$newChangeLogEntry = [pscustomobject]@{
ReleaseVersion = $Version
Expand Down