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.

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

Update format of new Changelog Entry #1633

Merged
3 commits merged into from
Jun 8, 2021

Conversation

chidozieononiwu
Copy link
Member

@chidozieononiwu chidozieononiwu commented May 25, 2021

Update changelog entry to match updated guidance https://azure.github.io/azure-sdk/policies_releases.html#change-logs

New Changelog entries will now look like

# Release History

## 1.15.0 (Unreleased)

### Features Added

### Breaking Changes

### Key Bugs Fixed

### Fixed


## 1.15.0-beta.1 (Unreleased)

### Features Added

- Types to represent `GeoJson` primitives.

@chidozieononiwu chidozieononiwu requested a review from a team as a code owner May 25, 2021 20:33
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@chidozieononiwu chidozieononiwu force-pushed the UpdateChangelogContentFormat branch from 640ffa6 to bef1cc7 Compare May 29, 2021 01:36
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@chidozieononiwu chidozieononiwu force-pushed the UpdateChangelogContentFormat branch from bef1cc7 to 9f63951 Compare June 3, 2021 05:08
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@chidozieononiwu chidozieononiwu force-pushed the UpdateChangelogContentFormat branch from 7cbb900 to df94b47 Compare June 4, 2021 23:26
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

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.

@ghost
Copy link

ghost commented Jun 8, 2021

Hello @azure-sdk!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@chidozieononiwu
Copy link
Member Author

/check-enforcer override

@ghost ghost merged commit 1028d93 into Azure:master Jun 8, 2021
@@ -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.

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants